ambari/ambari-server/docs/api/v1/host-components.md

List Host Components

Back to Resources

Summary

Returns a collection of components running on a given host.

GET /clusters/:name/hosts/:hostName/host_components

Response

<th>HTTP CODE</th>
<th>Description</th>

<td>200</td>
<td>OK</td>  

<td>400</td>
<td>Bad Request</td>  

<td>401</td>
<td>Unauthorized</td>  

<td>403</td>
<td>Forbidden</td>  

<td>404</td>
<td>Not Found</td>  

<td>500</td>
<td>Internal Server Error</td>  

Example

Returns a collection of components running on a the host named "h1" on the cluster named "c1".

GET /clusters/c1/hosts/h1/host_components

200 OK
{
    "href" : "http://your.ambari.server/api/v1/clusters/c1/hosts/host1/host_components",
    items" : [
        {
            "href" : "your.ambari.server/api/v1/clusters/c1/hosts/host1/host_components/DATANODE",
            "HostRoles" : {
                "cluster_name" : "c1",
                "component_name" : "DATANODE",
                "host_name" : "host1"
            },
            "host" : {
                "href" : "http://your.ambari.server/api/v1/clusters/c1/hosts/host1"
            }
        },
        {
            "href" : "your.ambari.server/api/v1/clusters/c1/hosts/host1/host_components/HBASE_CLIENT",
            "HostRoles" : {
                "cluster_name" : "c1",
                "component_name" : "HBASE_CLIENT",
                "host_name" : "host1"
            },
            "host" : {
                "href" : "http://your.ambari.server/api/v1/clusters/c1/hosts/host1"
            }
        },
        ...
    ]
}