查询一块或多块已创建的块存储(包括云盘、本地盘以及弹性临时盘)信息。
接口说明
-
请求参数
RegionId、ZoneId、DiskIds和InstanceId等都是过滤器的概念,参数间是逻辑与(AND)关系。 -
请求参数
DiskIds是一个 JSON 格式的数组(Array),如果参数为空,则过滤器不起作用,但是DiskIds如果是一个空数组,则视为该过滤器有效,且返回空。 -
支持 Token 分页查询:通过
NextToken设置查询凭证(Token),其取值是上一次调用 DescribeDisks 返回的NextToken参数值,再通过MaxResults设置单页查询的最大条目数。 -
开启多重挂载特性的云盘可以挂载到多个实例上,您可以根据返回结果的
Attachment列表查看云盘涉及的所有挂载信息。
通过阿里云 CLI 调用 API 时,不同数据类型的请求参数取值必须遵循格式要求。更多信息,请参见 CLI 参数格式说明。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:DescribeDisks |
list |
Disk
Disk
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
块存储所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| ZoneId |
string |
否 |
可用区 ID。 |
cn-hangzhou-g |
| DiskIds |
string |
否 |
云盘、本地盘或弹性临时盘 ID。一个带有格式的 JSON 数组,最多支持 100 个 ID,用半角逗号(,)隔开。 |
["d-bp67acfmxazb4p****", "d-bp67acfmxazb4g****", … "d-bp67acfmxazb4d****"] |
| InstanceId |
string |
否 |
云盘、本地盘或弹性临时盘挂载的实例 ID。 |
i-bp67acfmxazb4q**** |
| DiskType |
string |
否 |
要查询的云盘、本地盘或弹性临时盘类型。取值范围:
默认值:all。 说明
弹性临时盘不支持作为系统盘。 |
all |
| Category |
string |
否 |
磁盘种类。取值范围:
默认值:all。 |
all |
| Status |
string |
否 |
磁盘状态。更多信息,请参见云盘状态。取值范围:
默认值:All。 |
All |
| SnapshotId |
string |
否 |
创建云盘时使用的快照 ID。 |
s-bp67acfmxazb4p**** |
| Portable |
boolean |
否 |
磁盘是否支持卸载。取值范围:
以下类型块存储的
|
false |
| DeleteWithInstance |
boolean |
否 |
磁盘是否设置了随实例释放。取值范围:
默认值:false。 |
false |
| DeleteAutoSnapshot |
boolean |
否 |
释放云盘时,是否会同时释放自动快照。
默认值:false。 |
false |
| PageNumber |
integer |
否 |
说明
该参数即将下线,推荐您使用参数 |
1 |
| PageSize |
integer |
否 |
说明
该参数即将下线,推荐您使用参数 |
10 |
| NextToken |
string |
否 |
查询凭证(Token),取值为上一次调用 API 返回的 有关本接口查看返回数据的设置方式,请参见上文接口说明部分。 |
AAAAAdDWBF2**** |
| MaxResults |
integer |
否 |
返回的最大数。取值范围:10~500。 默认值:
|
50 |
| DiskName |
string |
否 |
磁盘的名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。 |
testDiskName |
| AutoSnapshotPolicyId |
string |
否 |
根据自动快照策略 ID 查询云盘。 |
sp-m5e2w2jutw8bv31**** |
| EnableAutoSnapshot |
boolean |
否 |
云盘是否启用自动快照策略功能。
说明
该参数已弃用。创建后的云盘默认启用自动快照策略功能,您只需要为云盘绑定自动快照策略即可正常使用。 |
true |
| EnableAutomatedSnapshotPolicy |
boolean |
否 |
云盘是否设置了自动快照策略。
默认值:false。 |
false |
| DiskChargeType |
string |
否 |
磁盘的计费方式。取值范围:
|
PostPaid |
| LockReason |
string |
否 |
磁盘被锁定的原因。取值范围:
|
security |
| Filter.1.Key |
string |
否 |
查询资源时的筛选键,取值必须为 |
CreationStartTime |
| Filter.2.Key |
string |
否 |
查询资源时的筛选键,取值必须为 |
CreationEndTime |
| Filter.1.Value |
string |
否 |
查询资源时的筛选值。指定该参数时必须同时指定 |
2017-12-05T22:40Z |
| Filter.2.Value |
string |
否 |
查询资源时的筛选值。指定该参数时必须同时指定 |
2017-12-06T22:40Z |
| ResourceGroupId |
string |
否 |
磁盘所在的企业资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。 说明
不支持默认资源组过滤。 |
rg-bp67acfmxazb4p**** |
| EnableShared |
boolean |
否 |
是否是共享块存储。 |
false |
| Encrypted |
boolean |
否 |
是否只筛选出加密云盘。
默认值:false。 |
false |
| DryRun |
boolean |
否 |
是否只预检此次请求。取值范围:
默认值:false。 |
false |
| KMSKeyId |
string |
否 |
云盘使用的 KMS 密钥 ID。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| MultiAttach |
string |
否 |
是否开启了多重挂载特性。取值范围:
|
Disabled |
| Tag |
array<object> |
否 |
磁盘标签列表。 |
|
|
object |
否 |
磁盘标签。 |
||
| key |
string |
否 |
磁盘的标签键。 说明
为提高代码兼容性,请尽量使用 Tag.N.Key 参数。 |
null |
| Key |
string |
否 |
磁盘的标签键。N 的取值范围:1~20。 使用一个标签过滤资源,查询到该标签下的资源数量不能超过 1000 个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个,请使用 ListTagResources 接口进行查询。 |
TestKey |
| Value |
string |
否 |
磁盘的标签值。N 的取值范围:1~20。 |
TestValue |
| value |
string |
否 |
磁盘的标签值。 说明
为提高代码兼容性,请尽量使用 Tag.N.Value 参数。 |
null |
| AdditionalAttributes |
array |
否 |
其他属性值列表。目前仅支持传入值为 说明
目前仅同城冗余类型的磁盘有数据存放地。 |
IOPS |
|
string |
否 |
其他属性值。目前仅支持传入值为 Placement,表示查询当前磁盘的数据存放地。 |
Placement |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| NextToken |
string |
本次调用返回的查询凭证值。 |
AAAAAdDWBF2**** |
| PageSize |
integer |
说明
该参数即将下线,推荐您使用参数 |
1 |
| PageNumber |
integer |
说明
该参数即将下线,推荐您使用参数 |
1 |
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| TotalCount |
integer |
查询结果总条数。 说明
使用 |
15 |
| Disks |
object |
||
| Disk |
array<object> |
磁盘信息组成的集合。 |
|
|
array<object> |
磁盘信息。 |
||
| SerialNumber |
string |
磁盘的序列号。 |
bp18um4r4f2fve2**** |
| CreationTime |
string |
创建时间。 |
2021-06-07T06:08:54Z |
| Status |
string |
磁盘状态。可能值:
|
In_use |
| Type |
string |
磁盘类型。可能值:
|
system |
| PerformanceLevel |
string |
ESSD 云盘的性能等级。可能值:
|
PL0 |
| BdfId |
string |
该参数正在邀测中,暂未开放使用。 |
null |
| EnableAutoSnapshot |
boolean |
云盘是否启用自动快照策略功能。 说明
该参数已弃用。创建后的云盘默认启用自动快照策略功能,您只需要为云盘绑定自动快照策略即可正常使用。 |
false |
| StorageSetId |
string |
存储集 ID。 |
ss-i-bp1j4i2jdf3owlhe**** |
| StorageSetPartitionNumber |
integer |
存储集中的最大分区数量。 |
11 |
| DiskId |
string |
磁盘 ID。 |
d-bp18um4r4f2fve24**** |
| DeleteAutoSnapshot |
boolean |
是否同时删除自动快照。可能值:
通过 CreateSnapshot 或者在控制台创建的快照,不受这个参数的影响,会始终保留。 |
false |
| StorageClusterId |
string |
云盘所属的专属块存储集群 ID。如果您的云盘在公共云块存储集群中,则该返回值为空。 |
dbsc-j5e1sf2vaf5he8m2**** |
| Encrypted |
boolean |
是否为加密云盘。 |
false |
| IOPSRead |
integer |
每秒读操作的次数上限,单位:次/s。 |
2000 |
| MountInstanceNum |
integer |
共享存储挂载的实例数量。 |
1 |
| Description |
string |
磁盘描述。 |
testDescription |
| Device |
string |
磁盘挂载的实例的设备名,例如/dev/xvdb。您需要注意:
说明
该参数即将停止使用,为提高代码兼容性,建议您尽量不要使用该参数。 |
/dev/xvdb |
| DiskName |
string |
磁盘名称。 |
testDiskName |
| Portable |
boolean |
磁盘是否可卸载。 |
false |
| ImageId |
string |
创建 ECS 实例时使用的镜像 ID,只有通过镜像创建的云盘才有值,否则为空。当创建磁盘的镜像被删除后,该值为空。 |
m-bp13aqm171qynt3u*** |
| KMSKeyId |
string |
云盘使用的 KMS 密钥 ID。 |
0e478b7a-4262-4802-b8cb-00d3fb408*** |
| DeleteWithInstance |
boolean |
是否随实例释放。可能值:
|
true |
| DetachedTime |
string |
该磁盘最后一次卸载时间。 |
2021-06-07T21:01:22Z |
| SourceSnapshotId |
string |
创建云盘使用的快照 ID。 如果创建云盘时,没有指定快照,则该参数值为空。如果创建云盘的快照被删除,该参数值为空。 |
s-bp67acfmxazb4p**** |
| AutoSnapshotPolicyId |
string |
云盘采用的自动快照策略 ID。 说明
该参数即将被弃用。如果云盘应用了多条自动快照策略,只会返回其中一条。建议您使用 DescribeAutoSnapshotPolicyAssociations 查询云盘应用的所有自动快照策略。 |
sp-bp67acfmxazb4p**** |
| EnableAutomatedSnapshotPolicy |
boolean |
云盘是否设置了自动快照策略。 |
false |
| IOPSWrite |
integer |
每秒写操作的次数上限,单位:次/s。 |
2000 |
| InstanceId |
string |
磁盘挂载的实例 ID。您需要注意:
|
i-bp67acfmxazb4q**** |
| IOPS |
integer |
每秒读写(I/O)操作的次数上限,单位:次/s。 |
4000 |
| RegionId |
string |
磁盘所属的地域 ID。 |
cn-hangzhou |
| ExpiredTime |
string |
包年包月磁盘的过期时间。 |
2021-07-07T16:00Z |
| Size |
integer |
磁盘大小,单位 GiB。 |
60 |
| ResourceGroupId |
string |
磁盘所在的企业资源组 ID。 |
rg-bp67acfmxazb4p**** |
| DiskChargeType |
string |
磁盘的计费方式。可能值:
|
PrePaid |
| ZoneId |
string |
磁盘所属的可用区 ID。 |
cn-hangzhou-i |
| AttachedTime |
string |
该磁盘最后一次挂载的时间。按照 ISO8601 标准表示,使用 UTC+0 时间。格式为:yyyy-MM-ddThh:mmZ。 |
2021-06-07T06:08:56Z |
| Category |
string |
磁盘种类。可能值:
|
cloud_ssd |
| ProductCode |
string |
云市场的商品标识。 |
jxsc000204 |
| MultiAttach |
string |
云盘是否开启了多重挂载特性。 |
Disabled |
| OperationLocks |
object |
||
| OperationLock |
array<object> |
磁盘锁定原因列表。 |
|
|
object |
磁盘锁定原因。 |
||
| LockReason |
string |
磁盘被安全锁定的原因。 |
security |
| MountInstances |
object |
||
| MountInstance |
array<object> |
共享存储挂载到实例上的信息集合。 |
|
|
object |
共享存储挂载到实例上的信息。 |
||
| AttachedTime |
string |
挂载时间。按照ISO 8601标准表示,使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-05T2340:00Z |
| InstanceId |
string |
磁盘挂载的实例 ID。 |
i-bp1j4i2jdf3owlhe**** |
| Device |
string |
磁盘的挂载点。 |
/dev/xvda |
| Tags |
object |
||
| Tag |
array<object> |
磁盘的标签集合。 |
|
|
object |
磁盘的标签。 |
||
| TagValue |
string |
标签值。 |
TestValue |
| TagKey |
string |
标签键。 |
TestKey |
| Attachments |
object |
||
| Attachment |
array<object> |
磁盘所涉及的挂载信息。由 |
|
|
object |
磁盘所涉及的挂载信息。 |
||
| InstanceId |
string |
所挂载的实例 ID。 |
i-bp67acfmxazb4q**** |
| Device |
string |
设备名称。 |
/dev/xvda |
| AttachedTime |
string |
挂载的时间,以 UTC +0 时间为准。 |
2021-06-07T06:08:56Z |
| ProvisionedIops |
integer |
ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50000, 1000容量-基准性能}。 基准性能=min{1,800+50容量, 50,000}。 当 |
40000 |
| BurstingEnabled |
boolean |
是否开启 Burst(性能突发)。可能值:
当 |
false |
| Throughput |
integer |
单位时间内可以成功传输的数据数量,单位:MB/s。 |
100 |
| ThroughputRead |
integer |
单位时间内系统可以成功读取的数据数量,单位:MB/s。 |
100 |
| ThroughputWrite |
integer |
单位时间内系统可以成功写入的数据数量,单位:MB/s。 |
100 |
| Placement |
object |
数据存放地集合。 只有入参指定 说明
当前仅有 ESSD 同城冗余类型(cloud_regional_disk_auto)磁盘具有有效值。 |
|
| ZoneIds |
string |
实际数据存放的可用区列表。 |
"["cn-hangzhou-b", "cn-hangzhou-j"]" |
| SourceDiskId |
string |
d-123********* |
|
| DataSource |
object |
||
| Id |
string |
||
| Type |
string |
示例
正常返回示例
JSON格式
{
"NextToken": "AAAAAdDWBF2****",
"PageSize": 1,
"PageNumber": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 15,
"Disks": {
"Disk": [
{
"SerialNumber": "bp18um4r4f2fve2****",
"CreationTime": "2021-06-07T06:08:54Z",
"Status": "In_use",
"Type": "system",
"PerformanceLevel": "PL0",
"BdfId": "null",
"EnableAutoSnapshot": false,
"StorageSetId": "ss-i-bp1j4i2jdf3owlhe****",
"StorageSetPartitionNumber": 11,
"DiskId": "d-bp18um4r4f2fve24****",
"DeleteAutoSnapshot": false,
"StorageClusterId": "dbsc-j5e1sf2vaf5he8m2****",
"Encrypted": false,
"IOPSRead": 2000,
"MountInstanceNum": 1,
"Description": "testDescription",
"Device": "/dev/xvdb",
"DiskName": "testDiskName",
"Portable": false,
"ImageId": "m-bp13aqm171qynt3u***",
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb408***",
"DeleteWithInstance": true,
"DetachedTime": "2021-06-07T21:01:22Z",
"SourceSnapshotId": "s-bp67acfmxazb4p****",
"AutoSnapshotPolicyId": "sp-bp67acfmxazb4p****",
"EnableAutomatedSnapshotPolicy": false,
"IOPSWrite": 2000,
"InstanceId": "i-bp67acfmxazb4q****",
"IOPS": 4000,
"RegionId": "cn-hangzhou",
"ExpiredTime": "2021-07-07T16:00Z",
"Size": 60,
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"DiskChargeType": "PrePaid",
"ZoneId": "cn-hangzhou-i",
"AttachedTime": "2021-06-07T06:08:56Z",
"Category": "cloud_ssd",
"ProductCode": "jxsc000204",
"MultiAttach": "Disabled",
"OperationLocks": {
"OperationLock": [
{
"LockReason": "security"
}
]
},
"MountInstances": {
"MountInstance": [
{
"AttachedTime": "2017-12-05T2340:00Z",
"InstanceId": "i-bp1j4i2jdf3owlhe****",
"Device": "/dev/xvda"
}
]
},
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"Attachments": {
"Attachment": [
{
"InstanceId": "i-bp67acfmxazb4q****",
"Device": "/dev/xvda",
"AttachedTime": "2021-06-07T06:08:56Z"
}
]
},
"ProvisionedIops": 40000,
"BurstingEnabled": false,
"Throughput": 100,
"ThroughputRead": 100,
"ThroughputWrite": 100,
"Placement": {
"ZoneIds": "\"[\"cn-hangzhou-b\",\n\"cn-hangzhou-j\"]\""
},
"SourceDiskId": "d-123*********",
"DataSource": {
"Id": "",
"Type": ""
}
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | 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 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | 指定的 Tag.N.Key 和 Tag.N.Value 不匹配。 |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | 指定的标记超出取值范围。 |
| 400 | InvalidRegion.NotFound | The specified parameter RegionId is not valid. | RegionId 参数不合法。 |
| 400 | InvalidZoneId.NotFound | The zoneId provided does not exist in our records. | 指定的可用区 ID 不存在。 |
| 400 | MissingParamter.RegionId | The regionId should not be null. | 参数 RegionId 不得为空。 |
| 400 | InvalidParameter.DiskIds | The specified parameter diskIds is not valid. | 指定的参数 diskIds 无效。 |
| 400 | IncompleteParamter | Some fields can not be null in this request. | 请求中缺失参数。 |
| 400 | InvalidParamter | Some parameters are invalid in this request. | 请求中包含非法参数。 |
| 400 | InvalidSnapshot.NotFound | The specified parameter SnapshotId is not valid. | 指定的 SnapshotId 不合法。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | InvalidDiskIds.Malformed | The amount of specified disk Ids exceeds the limit. | |
| 403 | InvalidCategory.ValueNotSupported | The specified disk category is not supported. | |
| 403 | UserNotInTheWhiteList | The user is not in volume white list. | |
| 403 | InvalidParameter.MultiAttachAndEnableSharedNotMatch | The parameter MultiAttach and EnableShared are not match. | 设置的 MultiAttach 参数和 EnableShared 参数的值不兼容。 |
| 403 | InvalidParameter.MultiAttach | The specified param MultiAttach is not valid. | MultiAttach 参数的取值有误。 |
| 404 | InvalidFilterKey.NotFound | The filter key is not found. | |
| 404 | InvalidFilterValue | The filter value is not valid. | |
| 404 | InvalidDiskIds.ValueNotSupported | The specified parameter "DiskIds" is not supported. | 指定的 DiskIds 参数值无效或格式非法 |
| 404 | InvalidDiskChargeType.NotFound | The DiskChargeType does not exist in our records. | 指定的磁盘计费方式不存在。 |
| 404 | InvalidLockReason.NotFound | The specified LockReason is not found. | 所指定的锁定原因不存在 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。