Updated on 2025-09-19 GMT+08:00

Querying the Resource Statistics

Function

This API is used to query the available resources, including available clusters and total clusters, available nodes and total nodes, and total capacity (GB).

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/statistics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

statistics

Array of Statistic objects

Definition

Resource quantity information list.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Statistic

Parameter

Type

Description

name

String

Definition

Resource name.

Constraints

N/A

Range

  • cluster.total: total number of clusters

  • cluster.normal: number of available clusters

  • instance.total: total number of nodes

  • instance.normal: number of available nodes

  • storage.total: total capacity (GB)

Default Value

N/A

value

Double

Definition

Resource quantity value.

Constraints

N/A

Range

N/A

Default Value

N/A

unit

String

Definition

Resource quantity unit.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/statistics

Example Responses

Status code: 200

Number of resources queried.

{
  "statistics" : [ {
    "name" : "cluster.total",
    "value" : 3,
    "unit" : null
  }, {
    "name" : "cluster.normal",
    "value" : 3,
    "unit" : null
  }, {
    "name" : "instance.total",
    "value" : 9,
    "unit" : null
  }, {
    "name" : "instance.normal",
    "value" : 9,
    "unit" : null
  }, {
    "name" : "storage.total",
    "value" : 1800,
    "unit" : "GB"
  } ]
}

Status Codes

Status Code

Description

200

Number of resources queried.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.