ambari/ambari-server/docs/api/v1/clusters-cluster.md

View Cluster Information

Back to Resources

Summary

Returns information for the specified cluster identified by ":name"

GET /clusters/:name

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

Get information for the cluster "c1".

GET /clusters/c1

200 OK
{
    "href" : "http://your.ambari.server/api/v1/clusters/c1",
    "Clusters" : {
        "cluster_name" : "c1",
        "cluster_id" : 1,
        "version" : "HDP-1.2.0"
    },
    "services" : [
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/NAGIOS",
            "ServiceInfo" : {
                "cluster_name" : "c1",
                "service_name" : "NAGIOS"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/HCATALOG",
            "ServiceInfo" : {
                "cluster_name" : "c1",
                "service_name" : "HCATALOG"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/PIG",
            "ServiceInfo" : {
                "cluster_name" : "c1",
                "service_name" : "PIG"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/MAPREDUCE",
            "ServiceInfo" : {
                "cluster_name" : "c1",
                "service_name" : "MAPREDUCE"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/GANGLIA",
            "ServiceInfo" : {
                "cluster_name" : "c1",
                "service_name" : "GANGLIA"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/HIVE",
            "ServiceInfo" : {
                "cluster_name" : "c1",
                "service_name" : "HIVE"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/HDFS",
            "ServiceInfo" : {
                "cluster_name" : "MyIE9",
                "service_name" : "HDFS"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/ZOOKEEPER",
            "ServiceInfo" : {
                "cluster_name" : "c1",
                "service_name" : "ZOOKEEPER"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/HBASE",
            "ServiceInfo" : {
                "cluster_name" : "c1",
                "service_name" : "HBASE"
            }
        },
        {
            "href" : "http://your.ambari.server/api/v1/clusters/c1/services/OOZIE",
            "ServiceInfo" : {
                "cluster_name" : "c1",
                "service_name" : "OOZIE"
            }
        } 
    ],
  "hosts" : [
    {
      "href" : "http://your.ambari.server/api/v1/clusters/c1/hosts/some.host",
      "Hosts" : {
          "cluster_name" : "c1",
          "host_name" : "some.host"
      }
    },
    {
      "href" : "http://your.ambari.server/api/v1/clusters/c1/hosts/another.host",
      "Hosts" : {
          "cluster_name" : "c1",
          "host_name" : "another.host"
      }
    }
  ]
}