阿里云如何使用查询磁盘接口

查询磁盘

描述

下面的参数中，RegionId，ZoneId，DiskIds，InstanceId，… 等参数都是过滤器的概念，参数间是逻辑与关系。其中 DiskIds 是一个 Json 格式的 Json Array，格式如下。

如果参数为空，则过滤器不起作用，但是 DiskIds 如果是一个空 Json Array(即[])，则视为该过滤器有效，且返回空。

请求参数

名称 类型 是否必须 描述 Action String 是 系统规定参数，取值：DescribeDisks RegionId String 是 磁盘所属于的 Region ID ZoneId String 否 默认值为空，空代表查询所有可用区下的磁盘。 DiskIds String 否 磁盘 ID

一个带有格式的 Json Array：[“d-xxxxxxxxx”, ”d-yyyyyyyyy”, … “d-zzzzzzzzz”]，最多 100 个 Id，用半角逗号字符隔开。 InstanceId String 否 实例 ID DiskType String 否 all | system | data，默认值为 all。 Category String 否 磁盘种类

all | cloud | cloud_efficiency | cloud_ssd | ephemeral | ephemeral_ssd。默认值为all Status String 否 磁盘状态

In_use | Available | Attaching | Detaching | Creating | ReIniting | All，默认值为 All。 SnapshotId String 否 创建磁盘使用的快照 DiskName String 否 磁盘名称 Portable String 否 磁盘是否支持卸载：

• true 代表是可卸载云盘，可以独立存在且可以自由在可用区内挂载和下载
• false 代表不可卸载云盘，只能和实例同生同灭

用户如果需要做 attach 和 detach 操作，必须先查询一下这个属性为 true 的磁盘才能操作。

本地磁盘，本地SSD盘 和 普通云盘，高效云盘和SSD云盘的系统盘 和 包月的普通云盘，高效云盘，SSD云盘，该属性都为 false。

这个属性用户不能更改。 DeleteWithInstance String 否 磁盘是否随实例释放：

• true 表示 Instance 释放时，这块磁盘随 Instance 一起释放
• false 表示 Instance 释放时，这块磁盘保留不释放

DeleteAutoSnapshot String 否 删除磁盘时，是否同时删除自动快照。

• true 表示同时删除自动快照
• false 表示保留自动快照

EnableAutoSnapshot String 否 磁盘是否执行自动快照策略（前提是用户整体的自动快照策略已经开启）：

• true，表示这块磁盘执行自动快照策略
• false，表示这块磁盘不执行自动快照策略

默认值：无，表示不改变当前的值 DiskChargeType String 否 磁盘的付费方式。

• PrePaid：预付费，即包年包月
• PostPaid：后付费，即按量付费

Tag.n.Key String 否 标签 key，n 从 1 开始，最大为 5。

不允许为空字符串。 Tag.n.Value String 否 标签 value，n 从 1 开始，最大为 5。

允许为空字符串。 PageNumber Integer 否 磁盘状态列表的页码，起始值为 1，默认值为 1 PageSize Integer 否 分页查询时设置的每页行数，最大值 100 行，默认为 10

返回参数

名称 类型 描述 RegionId String 镜像所属地域 Id TotalCount Integer 磁盘总个数 PageNumber Integer 磁盘列表的页码 PageSize Integer 输入时设置的每页行数 Disks DiskItemType 磁盘信息 DiskItemType 组成的集合

错误码

错误代码 描述 Http 状态码 语义 MissingParameter The input parameter "RegionId" that is mandatory for processing this request is not supplied. 400 RegionId 参数未指定 InvalidDiskType.ValueNotSupported The specified disk type is not supported. 400 指定的磁盘属性不支持 InvalidCategory.ValueNotSupported The specified disk category is not supported. 400 指定的磁盘种类不支持或者无权限 InvalidStatus.ValueNotSupported The specified disk status is not supported. 400 指定的磁盘状态不支持 InvalidParameter The specified parameter ""Portable"" is not valid. 400 指定的 Portable 参数不合法 InvalidParameter The specified parameter ""DeleteWithInstance"" is not valid. 400 指定的 DeleteWithInstance 参数不合法 InvalidParameter The specified parameter ""DeleteAutoSnapshot"" is not valid. 400 指定的 DeleteAutoSnapshot 参数不合法 InvalidParameter The specified parameter ""PageNumber"" is not valid. 400 指定的 PageNumber 参数不合法 InvalidParameter The specified parameter ""PageSize"" is not valid. 400 指定的 PageSize 参数不合法 InvalidDiskIds.Malformed The amount of specified disk Ids exceeds the limit. 403 指定的 DiskId 格式不正确 InvalidDiskChargeType.NotFound The DiskChargeType does not exist in our records 404 指定的 DiskChargeType 不存在

示例

请求示例

https://ecs.aliyuncs.com/?action=DescribeDisks

&RegionId=cn-qingdao

&PageNumber=1

&ZoneId=cn-qingdao-b

&<公共请求参数>

返回示例

XML格式：

true

false

false

cloud

5

data

2014-07-23T02:44:07Z

cn-qingdao-b

2014-07-23T07:47:35Z

2014-07-23T08:28:48Z

true

cn-qingdao

d-28m5zbua0

Available

true

false

false

cloud

5

data

2014-07-23T02:44:06Z

cn-qingdao-b

true

cn-qingdao

d-28zfrmo13

Available

1

2

9

ED5CF6DD-71CA-462C-9C94-A61A78A01479

JSON格式：

{

"Disks": {

"Disk": [

{

"AttachedTime": "2014-07-23T07:47:35Z",

"Category": "cloud",

"CreationTime": "2014-07-23T02:44:07Z",

"DeleteAutoSnapshot": true,

"DeleteWithInstance": false,

"EnableAutoSnapshot": false

"Description": "",

"DetachedTime": "2014-07-23T08:28:48Z",

"Device": "",

"DiskId": "d-28m5zbua0",

"DiskName": "",

"ImageId": "",

"InstanceId": "",

"OperationLocks": {

"OperationLock": []

},

"Portable": true,

"ProductCode": "",

"RegionId": "cn-qingdao",

"Size": 5,

"SourceSnapshotId": "",

"Status": "Available",

"Type": "data",

"ZoneId": "cn-qingdao-b"

},

{

"AttachedTime": "",

"Category": "cloud",

"CreationTime": "2014-07-23T02:44:06Z",

"DeleteAutoSnapshot": true,

"DeleteWithInstance": false,

"EnableAutoSnapshot": false

"Description": "",

"DetachedTime": "",

"Device": "",

"DiskId": "d-28zfrmo13",

"DiskName": "",

"ImageId": "",

"InstanceId": "",

"OperationLocks": {

"OperationLock": []

},

"Portable": true,

"ProductCode": "",

"RegionId": "cn-qingdao",

"Size": 5,

"SourceSnapshotId": "",

"Status": "Available",

"Type": "data",

"ZoneId": "cn-qingdao-b"

}

]

},

"PageNumber": 1,

"PageSize": 2,

"RequestId": "ACD9BBB0-A9D1-46D7-9630-B7A69889E110",

"TotalCount": 9

}

所属专题:

如果您觉得本文或图片不错，请把它分享给您的朋友吧！