.. _agent-status:

Agent Status
==============

Methods for determining agent health and operations on a node.

.. container:: api-toc

    ===================================================  =============================================
    :ref:`status`                                        URL
    ===================================================  =============================================
    Get all of the agent statuses                        :http:method:`get-all-agent-statuses`
    Get a single agent status                            :http:method:`get-one-agent-status`
    ===================================================  =============================================

.. _status:

Status
------------------

.. http:method:: GET /{cluster_id}/agents/
    :label-name: get-all-agent-statuses
    :title: GET /{cluster_id}/agents/

    Displays the status of all agents.

    :arg cluster_id: The ID of a cluster returned from :http:method:`get-cluster-configs`.

    **Example**:

    .. code-block:: bash

        curl http://127.0.0.1:8888/Test_Cluster/agents/

    Output:

    .. code-block:: js

        {
            "127.0.0.1": {
                "rack": "rack1", 
                "dc": "Cassandra", 
                "agent_install_type": "checkout", 
                "agent_status": {
                    "version": "6.0.0SNAPSHOT", 
                    "monitored_cassandra": {
                        "status": "up", 
                        "updated_at": 1456526258
                    }, 
                    "http": {
                        "status": "up", 
                        "updated_at": 1456526230
                    }, 
                    "jmx": {
                        "status": "up", 
                        "updated_at": 1456526258
                    }, 
                    "last_seen": 1456526258, 
                    "storage_cassandra": {
                        "status": "up", 
                        "updated_at": 1456526258
                    }, 
                    "stomp": {
                        "status": "up", 
                        "updated_at": 1456526258
                    }, 
                    "install_status": {
                        "state": null, 
                        "error-message": null
                    }
                }, 
                "name": "localhost"
            }
        } 


.. http:method:: GET /{cluster_id}/agents/{node_ip}
    :label-name: get-one-agent-status
    :title: GET /{cluster_id}/agents/{node_ip}

    Displays the status of a single agent.

    :arg cluster_id: The ID of a cluster returned from :http:method:`get-cluster-configs`.
    :arg node_ip: A node's ip address.

    **Example**:

    .. code-block:: bash

        curl http://127.0.0.1:8888/Test_Cluster/agents/127.0.0.1

    Output:

    .. code-block:: js

        {
            "127.0.0.1": {
                "rack": "rack1",
                "dc": "Cassandra",
                "agent_install_type": "checkout",
                "agent_status": {
                    "version": "6.0.0SNAPSHOT",
                    "monitored_cassandra": {
                        "status": "up",
                        "updated_at": 1456526258
                    },
                    "http": {
                        "status": "up",
                        "updated_at": 1456526230
                    },
                    "jmx": {
                        "status": "up",
                        "updated_at": 1456526258
                    },
                    "last_seen": 1456526258,
                    "storage_cassandra": {
                        "status": "up",
                        "updated_at": 1456526258
                    },
                    "stomp": {
                        "status": "up",
                        "updated_at": 1456526258
                    },
                    "install_status": {
                        "state": null,
                        "error-message": null
                    }
                },
                "name": "localhost"
            }
        }