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

View Service Components

Back to Resources

Summary

Returns a collection of all components for the service identified by ":serviceName" and the cluster identified by ":clusterName".

GET /clusters/:clusterName/services/:serviceName/components

Response

HTTP CODE	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Example

Returns a collection of all components for the HDFS service of the cluster "c1".

GET /clusters/c1/services/HDFS/components

200 OK
{
    "href" : "http://your.ambari.server/api/v1/clusters/c1/services/HDFS/components",
    "items" : [
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/HDFS/components/DATANODE",
            "ServiceComponentInfo" : {
                "cluster_name" : "c1",
                "component_name" : "DATANODE",
                "service_name" : "HDFS"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/HDFS/components/SECONDARY_NAMENODE",
            "ServiceComponentInfo" : {
                "cluster_name" : "c1",
                "component_name" : "SECONDARY_NAMENODE",
                "service_name" : "HDFS"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/HDFS/components/NAMENODE",
            "ServiceComponentInfo" : {
                "cluster_name" : "c1",
                "component_name" : "NAMENODE",
                "service_name" : "HDFS"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/HDFS/components/HDFS_CLIENT",
            "ServiceComponentInfo" : {
                "cluster_name" : "c1",
                "component_name" : "HDFS_CLIENT",
                "service_name" : "HDFS"
            }
        }
    ]
}