查询一块或多块您已经创建的专属块存储集群的云盘信息。
接口说明
-
支持以下两种方式查看返回数据：
- 方式一：通过
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）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ebs:DescribeDedicatedBlockStorageClusterDisks | get | *DedicatedBlockStorageCluster acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 专属块存储集群所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-heyuan |
| MaxResults | long | 否 | 分页查询时每页的最大条目数。最大值为 500。 默认值：10 | 10 |
| NextToken | string | 否 | 查询凭证（Token）。取值为上一次调用该接口返回的 NextToken 参数值，初次调用接口时无需设置该参数。 | AAAAAdDWBF2 |
| DbscId | string | 是 | 专属块存储集群 ID。 | dbsc-cn-od43bf**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****",
"NextToken": "AAAAAdDWBF2",
"Disks": {
"Disk": [
{
"DiskId": "d-bp67acfmxazb4p****",
"DiskName": "testDiskName",
"Status": "In_use",
"Type": "system",
"PerformanceLevel": "PL0",
"BdfId": "null",
"EnableAutoSnapshot": false,
"StorageSetId": "ss-i-bp1j4i2jdf3owlhe****",
"StorageSetPartitionNumber": 11,
"DeleteAutoSnapshot": false,
"StorageClusterId": "dbsc-j5e1sf2vaf5he8m2****",
"Encrypted": false,
"MountInstanceNum": 1,
"Description": "testDescription",
"Device": "/dev/xvdb",
"Portable": false,
"ImageId": "m-bp13aqm171qynt3u***",
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
"DeleteWithInstance": true,
"DetachedTime": "2021-06-07T21:01:22Z",
"SourceSnapshotId": "s-bp67acfmxazb4p****",
"InstanceId": "i-bp67acfmxazb4q****",
"Size": 60,
"RegionId": "cn-heyuan",
"ZoneId": "cn-heyuan-i",
"AttachedTime": "2021-06-07T06:08:56Z",
"Category": "cloud_essd",
"MultiAttach": "Disabled",
"Tags": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
],
"DiskChargeType": "PrePaid",
"IOPS": 4000,
"Throughput": 100,
"ProvisionedIops": 40000,
"BurstingEnabled": false
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Forbidden | User is not authorized to operate. | 当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。 |
| 403 | Forbidden.Action | User is not authorized to operate this action. | 当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。 |
| 404 | NoSuchResource | The specified resource does not exist. | 指定的资源不存在。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误。 |
| 504 | RequestTimeout | The request is timeout, please try again later. | 该请求超时，请稍后再重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-04-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |