查询磁盘信息
功能介绍
查询磁盘信息。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/dms/disk
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cluster_id | 否 | String | 参数解释: 集群ID。获取方法请参见获取集群ID。 约束限制: 必须是有效的dws集群ID。 取值范围: 36位UUID。 默认取值: 不涉及。 |
| instance_id | 否 | String | 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_name | 否 | String | 参数解释: 实例名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 分页单页大小。 约束限制: 不涉及。 取值范围: 大于0。 默认取值: 不限制。 |
| offset | 否 | Integer | 参数解释: 分页偏移量,从0开始,页数减1。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of DiskResp objects | 参数解释: 磁盘信息响应体。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instance_name | String | 参数解释: 实例名称。 取值范围: 不涉及。 |
| instance_id | String | 参数解释: 实例ID。 取值范围: 不涉及。 |
| host_name | String | 参数解释: 主机名称。 取值范围: 不涉及。 |
| disk_name | String | 参数解释: 磁盘名称。 取值范围: 不涉及。 |
| disk_type | String | 参数解释: 磁盘类型(系统盘、数据盘、日志盘)。 取值范围: 不涉及。 |
| total | Double | 参数解释: 磁盘总容量(GB)。 取值范围: 不涉及。 |
| used | Double | 参数解释: 磁盘已使用容量(GB)。 取值范围: 不涉及。 |
| available | Double | 参数解释: 磁盘可用容量(GB)。 取值范围: 不涉及。 |
| used_percentage | Double | 参数解释: 磁盘使用率(%)。 取值范围: 不涉及。 |
| await | Double | 参数解释: IO等待时间(ms)。 取值范围: 不涉及。 |
| svctm | Double | 参数解释: IO服务时间(ms)。 取值范围: 不涉及。 |
| util | Double | 参数解释: IO使用率(%)。 取值范围: 不涉及。 |
| read_rate | Double | 参数解释: 磁盘读速率(KB/s)。 取值范围: 不涉及。 |
| write_rate | Double | 参数解释: 磁盘写速率(KB/s)。 取值范围: 不涉及。 |
请求示例
查询磁盘信息。
https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/disk?limit=1&offset=0 响应示例
状态码:200
查询磁盘信息成功。
[ {
"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
} ] 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询磁盘信息成功。 |
| 400 | 请求错误。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 404 | 找不到资源。 |
| 500 | 服务内部错误。 |
| 503 | 服务不可用。 |