Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET statisticsService/clusters

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Fetches the details of Clusters

Since Product Version: 3.1

Resource URL

/webacs/api/v2/op/statisticsService/clusters

Request Parameters

Type Attribute Name Source Description

String

datacenter optional

query

Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.

String

cluster optional

query

Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.

Boolean

children optional

query

Parameter that needs to be set to true to fetch children of the Cluster. Children of a cluster are hypervisors that are part of it.

String

Range optional

query

Integer

firstResult optional

query

TBD

Integer

maxResults optional

query

TBD

String

sort optional

query

Response Parameters

Type Attribute Name Description

ResourceDetailsDTO[]

resources

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Response Payload

https://172.25.123.114/webacs/api/v2/op/statisticsService/clusters?datacenter="DC1"&cluster="CL1"&firstResult=0&maxResults=10&sort=-cluster

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v2/op/statisticsService/clusters?datacenter=&amp;quot;DC1&amp;quot;&amp;amp;cluster=&amp;quot;CL1&amp;quot;&amp;amp;firstResult=0&amp;amp;maxResults=10&amp;amp;sort=-cluster
					" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <resourcesDTO>
    <resources>
      <resources>
        <childrenLink>String value</childrenLink>
        <description>String value</description>
        <details>
          <item key="String value">
            <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
          </item>
        </details>
        <metricsLink>String value</metricsLink>
        <name>String value</name>
        <type>String value</type>
      </resources>
    </resources>
  </resourcesDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v2/op/statisticsService/clusters.json?datacenter="DC1"&cluster="CL1"&firstResult=0&maxResults=10&sort=-cluster

{
  "mgmtResponse" : {
    "@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/clusters?datacenter=&quot;DC1&quot;&amp;cluster=&quot;CL1&quot;&amp;firstResult=0&amp;maxResults=10&amp;sort=-cluster\n\t\t\t\t\t",
    "@responseType" : "operation",
    "@rootUrl" : "https://172.25.123.114/webacs/api/v1/op/",
    "resourcesDTO" : [ {
      "resources" : {
        "resources" : [ {
          "childrenLink" : "String value",
          "description" : "String value",
          "details" : [ {
            "@key" : "String value",
            "value" : "String value"
          } ],
          "metricsLink" : "String value",
          "name" : "String value",
          "type" : "String value"
        } ]
      }
    } ]
  }
}