查询一块或多块已创建的块存储(包括云盘、本地盘以及弹性临时盘)信息。
接口说明
-
请求参数
RegionId
、ZoneId
、DiskIds
和InstanceId
等都是过滤器的概念,参数间是逻辑与(AND)关系。 -
请求参数
DiskIds
是一个 JSON 格式的数组(Array),如果参数为空,则过滤器不起作用,但是DiskIds
如果是一个空数组,则视为该过滤器有效,且返回空。 -
支持以下两种方式查看返回数据:
- 方式一:通过
NextToken
设置查询凭证(Token),其取值是上一次调用 DescribeDisks 返回的NextToken
参数值,再通过MaxResults
设置单页查询的最大条目数。 - 方式二:通过
PageSize
设置单页返回的条目数,再通过PageNumber
设置页码。
以上两种方式只能任选其中之一。当返回的条目数较多时,推荐使用方式一。如果设置了
NextToken
,则请求参数PageSize
和PageNumber
将失效,且返回数据中的TotalCount
无效。 - 方式一:通过
-
开启多重挂载特性的云盘可以挂载到多个实例上,您可以根据返回结果的
Attachment
列表查看云盘涉及的所有挂载信息。
通过阿里云 CLI 调用 API 时,不同数据类型的请求参数取值必须遵循格式要求。更多信息,请参见 CLI 参数格式说明。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:DescribeDisks | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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。 默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。 最大值:100。 默认值:10。 | 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 | 否 | 磁盘被锁定的原因。取值范围:
| recycling |
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,表示查询当前磁盘的 IOPS 上限。 | |
string | 否 | 其他属性值。目前仅支持传入值为 IOPS,表示查询当前磁盘的 IOPS 上限。 | IOPS |
返回参数
示例
正常返回示例
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\ncn-hangzhou-j"
}
}
]
}
}
错误码
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 不合法。 |
403 | InvalidDiskIds.Malformed | The amount of specified disk Ids exceeds the limit. | 指定的磁盘 ID 格式不正确。 |
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. | - |
404 | InvalidDiskChargeType.NotFound | The DiskChargeType does not exist in our records. | 指定的磁盘计费方式不存在。 |
404 | InvalidLockReason.NotFound | The specified LockReason is not found. | 所指定的锁定原因不存在 |
500 | InternalError | The request processing has failed due to some unknown error. | 内部错误,请重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-08 | OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-11-24 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |