You can call this operation to query dashboard data.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeClusterDashboard

The operation that you want to perform. Set the value to DescribeClusterDashboard.

ClusterId String Yes cds-bp14****135h

The ID of the cluster.

Response parameters

Parameter Type Example Description
Dashboard Struct

The collection of dashboard data.

ClusterId String cds-bp1syjlt****q976

The ID of the cluster.

DataCenters Array

The list of data centers.

DataCenter
DataCenterId String cn-shanghai-e

The ID of the data center in the cluster.

Nodes Array

The collection of nodes.

Node
Address String 192.***.12.3

The IP address of the instance.

Load String 54.4 MiB

The load of the instance.

Status String UpNormal

The current status of the node. Valid values:

  • UpNormal: The node is running and is normal in the cluster.
  • UpLeaving: The node is running and is disconnected in the cluster.
  • UpJoining: The node is running and is connected in the cluster.
  • UpMovving: The node is running and is removed in the cluster.
  • DownNormal: The node stops running and is normal in the cluster.
  • DownLeaving: The node stops running and is disconnected in the cluster.
  • DownJoining: The node stops running and is connected in the cluster.
  • DownMovving: The node stops running and is removed from the cluster.

Note that if "?N" appears, nodes may be disconnected from each other. Check the network or firewall.

RequestId String 9339F598-0560-43CE-9F57-CD7B6B385DBB

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeClusterDashboard
&ClusterId=cds-bp14****135h
&<Common request parameters>

Sample success responses

XML format

<DescribeClusterDashboardResponse>
      <RequestId>9339F598-0560-43CE-9F57-CD7B6B385DBB</RequestId>
      <Dashboard>
            <DataCenters>
                  <DataCenter>
                        <DataCenterId>cn-shanghai-e</DataCenterId>
                        <Nodes>
                              <Node>
                                    <Status>UpNormal</Status>
                                    <Load>54.4 MiB</Load>
                                    <Address>192. ***.0.208</Address>
                              </Node>
                              <Node>
                                    <Status>UpNormal</Status>
                                    <Load>49.99 MiB</Load>
                                    <Address>192. ***.0.209</Address>
                              </Node>
                              <Node>
                                    <Status>UpNormal</Status>
                                    <Load>37.8 MiB</Load>
                                    <Address>192. ***.0.211</Address>
                              </Node>
                        </Nodes>
                  </DataCenter>
            </DataCenters>
            <ClusterId>cds-uf6m0bod4***6159</ClusterId>
      </Dashboard>
</DescribeClusterDashboardResponse>

JSON format

{
  "RequestId": "9339F598-0560-43CE-9F57-CD7B6B385DBB",
  "Dashboard": {
    "DataCenters": {
      "DataCenter": [
        {
          "DataCenterId": "cn-shanghai-e",
          "Nodes": {
            "Node": [
              {
                "Status": "UpNormal",
                "Load": "54.4 MiB",
                "Address": "192. ***.0.208"
              },
              {
                "Status": "UpNormal",
                "Load": "49.99 MiB",
                "Address": "192. ***.0.209"
              },
              {
                "Status": "UpNormal",
                "Load": "37.8 MiB",
                "Address": "192. ***.0.211"
              }
            ]
          }
        }
      ]
    },
    "ClusterId": "cds-uf6m0bod4***6159"
  }
}

Error codes

For a list of error codes, visit the API Error Center.