Querying Disk Information

Function

This API is used to query disk information.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/dms/disk

**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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cluster_id	No	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
instance_id	No	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A
instance_name	No	String	Definition Instance name. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Size of a single page. Constraints N/A Range Greater than 0 Default Value No limit.
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

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of DiskResp objects	Definition Disk information response body. Range N/A

**Table 4** DiskResp
Parameter	Type	Description
instance_name	String	Definition Instance name. Range N/A
instance_id	String	Definition Instance ID. Range N/A
host_name	String	Definition Host name. Range N/A
disk_name	String	Definition Disk name. Range N/A
disk_type	String	Definition Disk type (system disk, data disk, or log disk). Range N/A
total	Double	Definition Total disk capacity, in GB. Range N/A
used	Double	Definition Used disk capacity, in GB. Range N/A
available	Double	Definition Available disk capacity, in GB. Range N/A
used_percentage	Double	Definition Disk usage (%). Range N/A
await	Double	Definition I/O wait time (ms). Range N/A
svctm	Double	Definition I/O service time (ms). Range N/A
util	Double	Definition I/O usage (%). Range N/A
read_rate	Double	Definition Disk read rate (KB/s). Range N/A
write_rate	Double	Definition Disk write rate (KB/s). Range N/A

Example Requests

Query disk information.

https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/disk?limit=1&offset=0

Example Responses

Status code: 200

Disk information queried.

[ {
  "instance_name" : "dms-test07-dws-cn-cn-1-1",
  "host_name" : "host-172-16-11-62",
  "disk_name" : "vda",
  "disk_type" : "system",
  "total" : 49,
  "used" : 5.64,
  "available" : 40.99,
  "used_percentage" : 11.51,
  "await" : 0.21,
  "svctm" : 0.03,
  "util" : 0.01,
  "read_rate" : 0,
  "write_rate" : 52.72
} ]

Status Codes

Status Code	Description
200	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.