Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: luhuayi <luhuayi@huawei.com> Co-committed-by: luhuayi <luhuayi@huawei.com>
12 KiB
Querying Disk Information of a Logical Cluster
Function
This API is used to query the disk information of a logical cluster.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/volumes
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 |
cluster_id |
Yes |
String |
Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints The value must be a valid DWS cluster ID. Range It is a 36-digit UUID. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
offset |
No |
Integer |
Definition Page offset, which starts from 0 (page number minus 1). Constraints N/A Range Greater than or equal to 0 Default Value 0 |
limit |
No |
Integer |
Definition Size of a single page. Constraints N/A Range Greater than 0 Default Value 10 |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
volumes |
Array of LogicalClusterVolume objects |
Definition Disk information list of the logical cluster. Range N/A |
count |
Long |
Definition Total number of disks in the logical cluster. Range N/A |
Example Requests
Query the disk information of a logical cluster.
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters/volumes
Example Responses
Status code: 200
Cluster disk information queried.
{
"volumes" : [ {
"logical_cluster_name" : "v3_logical",
"usage" : "1.0G",
"total" : "10.0G",
"percent" : 0.1
} ],
"count" : 1
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Cluster disk information 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. |