查询磁盘列表
1. 接口描述
调用 DescribeDisks 接口查询您已经创建的磁盘信息。
2. 请求参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 固定取值:DescribeDisks |
RegionCode | String | 是 | 磁盘所属的地域编码,您可以调用 DescribeRegionConfig 查看最新的地域列表 |
ZoneCode | String | 否 | 磁盘所属的可用区编码,您可以调用 DescribeZoneConfig 查看可用区列表 |
InstanceUUID | String | 否 | 实例ID |
PageNumber | integer | 否 | 磁盘列表的页码, 最大值:10 默认值:1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。 最大值:50 默认值:10 |
3. 返回数据
名称 | 类型 | 说明 |
---|---|---|
Items | Array[ DiskInfo ] | 磁盘信息列表 |
RequestId | String | 请求ID |
Total | Integer | 磁盘总数 |
4. 示例
请求示例
https://openapi.kaopuyun.com/?SignatureVersion=1.0
&Action=DescribeDisks
&Format=JSON
&PageSize=50
&RegionCode=cn-hongkong-3
&SignatureNonce=fad368fd-b5e3-476b-903b-2ef34e0e9fba
&Version=2014-05-26
&AccessKeyId=hfWkfqG6a794
&Signature=IcyHYfUBWSzJauAbDaqniNSNE94=
&SignatureMethod=HMAC-SHA1
&Timestamp=2023-02-25T15:29:21Z
正常返回示例
{
"Items": [{
"DiskUUID":"disk-vx0000k0g9jw",
"RegionCode":"xxxxxx",
"ZoneCode":"xxxxxx",
"Type":"SYSTEM",
"DiskName":"xxxx",
"Category":"CLOUD",
"Size":50,
"InstanceUUID":"ecs-vx0000k0g9ja",
"Device":"xxxx",
"AutoRenew" : "NONE",
"DiskPendingStatus":"NONE",
"DiskStatus":"AVAILABLE",
"CreationTime":"2019-10-30 11:32:41",
"ExpirationTime":"2019-11-30 11:32:41"
}],
"Total": 10,
"RequestId":"742fbe80-0ea9-11eb-9b36-0208cb7f7896"
}
5. 错误码
错误码 | 错误信息 |
---|---|
MissingParameter | RegionCode 参数不能为空 |
AvailableRegionNotFound | 可用的地域未找到 |
AvailableZoneNotFound | 可用的可用区未找到 |
InvalidPageNumber | 分页数错误 |
InvalidPageSize | 每页数量错误 |
DescribeDisksFail | 查询磁盘列表失败:xxx |