Help Center/ Cloud Search Service/ API Reference (Ally Region)/ API V1/ Cluster Management/ Query the disk usage of a cluster.
Updated on 2026-09-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Query the disk usage of a cluster.

Function

Query the disk usage of a cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/volume

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID and Name.

Constraints

N/A

Range

Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits.

Default Value

N/A

cluster_id

Yes

String

Definition

ID of the cluster to query. For details about how to obtain the cluster ID, see Obtaining a Cluster 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

diskInfoList

Array of DiskInfo objects

Definition:

Disk usage of each node.

Value range:

N/A
Table 3 DiskInfo

Parameter

Type

Description

id

String

Definition:

Node ID.

Value range:

N/A

name

String

Definition:

Node name.

Value range:

N/A

diskCapacity

String

Definition

Total node storage capacity, in GB.

Range

N/A

diskUsed

String

Definition

Used node storage capacity, in GB.

Range

N/A

percentage

String

Definition

Node storage usage, in percentage.

Range

N/A

Example Requests

Query the disk usage of each node in a cluster.

GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/volume

Example Responses

Status code: 200

Returned value for querying the disk usage of each node in a cluster.

{
  "diskInfoList" : [ {
    "percentage" : "5.16",
    "diskCapacity" : "97.86",
    "diskUsed" : "5.05",
    "id" : "700915c3-15da-455f-9a6e-8b853b8665ac",
    "name" : "css-9062-ess-esn-1-1"
  } ]
}

Status Codes

Status Code

Description

200

Returned value for querying the disk usage of each node in a cluster.

Error Codes

See Error Codes.

Parent topic: Cluster Management