DescribeDedicatedBlockStorageClusterDisks - 查询专属块存储集群中的云盘列表 - 云服务器 ECS

查询一块或多块您已经创建的专属块存储集群的云盘信息。

接口说明

支持以下两种方式查看返回数据：
- 方式一：通过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****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	11B55F58-D3A4-4A9B-9596-342420D0****
NextToken	string	本次调用返回的查询凭证值。	AAAAAdDWBF2
Disks	object	云盘信息组成的集合。
Disk	array<object>	云盘信息组成的集合。
Disk	object	云盘信息组成的集合。
DiskId	string	云盘 ID。	d-bp67acfmxazb4p****
DiskName	string	云盘名称。	testDiskName
Status	string	云盘状态。更多信息，请参见云盘状态。可能值： In_use。 Available。 Attaching。 Detaching。 Creating。 ReIniting。	In_use
Type	string	要查询的云盘类型。可能值： system：系统盘。 data：数据盘。	system
PerformanceLevel	string	ESSD 云盘的性能等级。可能值： PL0：单盘最高随机读写 IOPS 1 万。 PL1：单盘最高随机读写 IOPS 5 万。 PL2：单盘最高随机读写 IOPS 10 万。 PL3：单盘最高随机读写 IOPS 100 万。	PL0
BdfId	string	该参数正在邀测中，暂未开放使用。	null
EnableAutoSnapshot	boolean	云盘是否启用自动快照策略功能。	false
StorageSetId	string	存储集 ID。	ss-i-bp1j4i2jdf3owlhe****
StorageSetPartitionNumber	integer	存储集中的最大分区数量。	11
DeleteAutoSnapshot	boolean	是否同时删除自动快照。可能值： true：删除云盘上的快照。 false：保留云盘上的快照。通过 CreateSnapshot 或者在控制台创建的快照，不受这个参数的影响，会始终保留。	false
StorageClusterId	string	云盘所属的专属块存储集群 ID。如果您的云盘在公共云块存储集群中，则该返回值为空。	dbsc-j5e1sf2vaf5he8m2****
Encrypted	boolean	是否为加密云盘。	false
MountInstanceNum	integer	共享存储挂载的实例数量。	1
Description	string	云盘描述信息。	testDescription
Device	string	云盘挂载的实例的设备名，例如/dev/xvdb。您需要注意：该参数仅在`Status`参数值为`In_use`时才有值，其他状态时为空。对于开启多重挂载特性的云盘，该值始终为空。您可以通过返回的`Attachment`对象组成的列表，查看云盘所涉及的所有挂载信息。说明该参数即将停止使用，为提高代码兼容性，建议您尽量不要使用该参数。	/dev/xvdb
Portable	boolean	云盘是否可卸载。	false
ImageId	string	创建 ECS 实例时使用的镜像 ID，只有通过镜像创建的云盘才有值，否则为空。这个值在云盘的生命周期内始终不变。	m-bp13aqm171qynt3u***
KMSKeyId	string	云盘使用的 KMS 密钥 ID。	0e478b7a-4262-4802-b8cb-00d3fb40****
DeleteWithInstance	boolean	是否随实例释放。可能值： true：释放实例时，这块云盘随实例一起释放。 false：释放实例时，这块云盘保留不释放。	true
DetachedTime	string	该云盘最后一次卸载时间。	2021-06-07T21:01:22Z
SourceSnapshotId	string	创建云盘使用的快照 ID。如果创建云盘时，没有指定快照，则该参数值为空。该参数值在云盘的生命周期内始终不变。	s-bp67acfmxazb4p****
InstanceId	string	云盘挂载的实例 ID。您需要注意：该参数值仅在`Status`参数值为`In_use`时才有值，其他状态时为空。对于开启多重挂载特性的云盘，该值始终为空。您可以通过返回的`Attachment`对象组成的列表，查看云盘所涉及的所有挂载信息。	i-bp67acfmxazb4q****
Size	integer	云盘大小，单位为 GiB。	60
RegionId	string	云盘所属的地域 ID。	cn-heyuan
ZoneId	string	云盘所属的可用区 ID。	cn-heyuan-i
AttachedTime	string	该云盘最后一次挂载的时间。按照ISO 8601标准表示，使用 UTC+0 时间。格式为：yyyy-MM-ddThh:mmZ。	2021-06-07T06:08:56Z
Category	string	云盘或本地盘种类为 cloud_essd，表示 ESSD 云盘。	cloud_essd
MultiAttach	string	云盘是否开启了多重挂载特性。	Disabled
Tags	array<object>	云盘的标签集合。
tags	object	云盘的标签集合。
TagValue	string	标签值。	TestValue
TagKey	string	标签键。	TestKey
DiskChargeType	string	云盘的计费方式。可能值： PrePaid：包年包月。 PostPaid：按量付费。	PrePaid
IOPS	long	每秒读写（I/O）操作的次数上限，单位：次/s。	4000
Throughput	long	单位时间内可以成功传输的数据数量，单位：MB/s。	100
ProvisionedIops	long	ESSD AutoPL 云盘预配置的读写 IOPS。可能值：0~min{50000, 1000容量-基准性能}。基准性能=min{1,800+50容量, 50,000}。当`DiskCategory`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见ESSD AutoPL 云盘。	40000
BurstingEnabled	boolean	是否开启 Burst（性能突发）。可能值： true：是。 false：否。当`DiskCategory`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见ESSD AutoPL 云盘。	false

示例

正常返回示例

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 返回结构发生变更	查看变更详情