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

接口说明

  • 支持以下两种方式查看返回数据:
    • 方式一:通过NextToken设置查询凭证(Token),其取值是上一次调用DescribeDisks返回的NextToken参数值,再通过MaxResults设置单页查询的最大条目数。
    • 方式二:通过PageSize设置单页返回的条目数,再通过PageNumber设置页码。

      以上两种方式只能任选其中之一。当返回的条目数较多时,推荐使用方式一。如果设置了NextToken,则请求参数PageSizePageNumber将失效,且返回数据中的TotalCount无效。

  • 开启多重挂载特性的云盘可以挂载到多个实例上,您可以根据返回结果的Attachment列表查看云盘涉及的所有挂载信息。

通过阿里云CLI调用API时,不同数据类型的请求参数取值必须遵循格式要求。更多信息,请参见CLI参数格式说明

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDedicatedBlockStorageClusterDisks

系统规定参数。取值:DescribeDedicatedBlockStorageClusterDisks

RegionId String cn-heyuan

专属块存储集群所在的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

MaxResults Long 10

分页查询时每页的最大条目数。最大值为500。

默认值:10

NextToken String AAAAAdDWBF2

查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。

DbscId String dbsc-cn-od43bf****

专属块存储集群ID。

返回数据

名称 类型 示例值 描述
RequestId String 11B55F58-D3A4-4A9B-9596-342420D0****

请求ID。

NextToken String AAAAAdDWBF2

本次调用返回的查询凭证值。

Disks Object

云盘信息组成的集合。

Disk Array of Disk

云盘信息组成的集合。

DiskId String d-bp67acfmxazb4p****

云盘ID。

DiskName String testDiskName

云盘名称。

Status String In_use

云盘状态。更多信息,请参见云盘状态。可能值:

  • In_use。
  • Available。
  • Attaching。
  • Detaching。
  • Creating。
  • ReIniting。
Type String all

要查询的云盘类型。可能值:

  • system:系统盘。
  • data:数据盘。
PerformanceLevel String PL0

ESSD云盘的性能等级。可能值:

  • PL0:单盘最高随机读写IOPS 1万。
  • PL1:单盘最高随机读写IOPS 5万。
  • PL2:单盘最高随机读写IOPS 10万。
  • PL3:单盘最高随机读写IOPS 100万。
BdfId String null

该参数正在邀测中,暂未开放使用。

EnableAutoSnapshot Boolean false

云盘是否启用自动快照策略功能。

StorageSetId String ss-i-bp1j4i2jdf3owlhe****

存储集ID。

StorageSetPartitionNumber Integer 11

存储集中的最大分区数量。

DeleteAutoSnapshot Boolean false

是否同时删除自动快照。可能值:

  • true:删除云盘上的快照。
  • false:保留云盘上的快照。

通过CreateSnapshot或者在控制台创建的快照,不受这个参数的影响,会始终保留。

StorageClusterId String dbsc-j5e1sf2vaf5he8m2****

云盘所属的专属块存储集群ID。如果您的云盘在公共云块存储集群中,则该返回值为空。

Encrypted Boolean false

是否为加密云盘。

IOPSRead Long 2000

每秒读操作的次数上限,单位:次/s。

MountInstanceNum Integer 1

共享存储挂载的实例数量。

Description String testDescription

云盘描述信息。

Device String /dev/xvdb

云盘挂载的实例的设备名,例如/dev/xvdb。您需要注意:

  • 该参数仅在Status参数值为In_use时才有值,其他状态时为空。
  • 对于开启多重挂载特性的云盘,该值始终为空。您可以通过返回的Attachment对象组成的列表,查看云盘所涉及的所有挂载信息。
说明 该参数即将停止使用,为提高代码兼容性,建议您尽量不要使用该参数。
Portable Boolean false

云盘是否可卸载。

ImageId String m-bp13aqm171qynt3u***

创建ECS实例时使用的镜像ID,只有通过镜像创建的云盘才有值,否则为空。这个值在云盘的生命周期内始终不变。

KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40****

云盘使用的KMS密钥ID。

DeleteWithInstance Boolean true

是否随实例释放。可能值:

  • true:释放实例时,这块云盘随实例一起释放。
  • false:释放实例时,这块云盘保留不释放。
DetachedTime String 2021-06-07T21:01:22Z

该云盘最后一次卸载时间。

SourceSnapshotId String s-bp67acfmxazb4p****

创建云盘使用的快照ID。

如果创建云盘时,没有指定快照,则该参数值为空。该参数值在云盘的生命周期内始终不变。

InstanceId String i-bp67acfmxazb4q****

云盘挂载的实例ID。您需要注意:

  • 该参数值仅在Status参数值为In_use时才有值,其他状态时为空。
  • 对于开启多重挂载特性的云盘,该值始终为空。您可以通过返回的Attachment对象组成的列表,查看云盘所涉及的所有挂载信息。
Size Integer 60

云盘大小,单位为GiB。

RegionId String cn-heyuan

云盘所属的地域ID。

ZoneId String cn-heyuan-i

云盘所属的可用区ID。

AttachedTime String 2021-06-07T06:08:56Z

该云盘最后一次挂载的时间。按照ISO8601标准表示,使用UTC+0时间。格式为:yyyy-MM-ddThh:mmZ。

Category String cloud_essd

云盘或本地盘种类为cloud_essd,表示ESSD云盘。

MultiAttach String Disabled

云盘是否开启了多重挂载特性。

Tags Array of tags

云盘的标签集合。

TagValue String TestValue

标签值。

TagKey String TestKey

标签键。

DiskChargeType String PrePaid

云盘的计费方式。可能值:

  • PrePaid:包年包月。
  • PostPaid:按量付费。
IOPS Long 4000

每秒读写(I/O)操作的次数上限,单位:次/s。

示例

请求示例

https://ebs.cn-heyuan.aliyuncs.com/?Action=DescribeDedicatedBlockStorageClusterDisks
&RegionId=cn-heyuan
&MaxResults=10
&NextToken=AAAAAdDWBF2
&DbscId=dbsc-cn-od43bf****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDedicatedBlockStorageClusterDisksResponse>
    <RequestId>11B55F58-D3A4-4A9B-9596-342420D0****</RequestId>
    <NextToken>AAAAAdDWBF2</NextToken>
    <Disks>
        <Disk>
            <DiskId>d-bp67acfmxazb4p****</DiskId>
            <DiskName>testDiskName</DiskName>
            <Status>In_use</Status>
            <Type>all</Type>
            <PerformanceLevel>PL0</PerformanceLevel>
            <BdfId>null</BdfId>
            <EnableAutoSnapshot>false</EnableAutoSnapshot>
            <StorageSetId>ss-i-bp1j4i2jdf3owlhe****</StorageSetId>
            <StorageSetPartitionNumber>11</StorageSetPartitionNumber>
            <DeleteAutoSnapshot>false</DeleteAutoSnapshot>
            <StorageClusterId>dbsc-j5e1sf2vaf5he8m2****</StorageClusterId>
            <Encrypted>false</Encrypted>
            <IOPSRead>2000</IOPSRead>
            <MountInstanceNum>1</MountInstanceNum>
            <Description>testDescription</Description>
            <Device>/dev/xvdb</Device>
            <Portable>false</Portable>
            <ImageId>m-bp13aqm171qynt3u***</ImageId>
            <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>
            <DeleteWithInstance>true</DeleteWithInstance>
            <DetachedTime>2021-06-07T21:01:22Z</DetachedTime>
            <SourceSnapshotId>s-bp67acfmxazb4p****</SourceSnapshotId>
            <InstanceId>i-bp67acfmxazb4q****</InstanceId>
            <Size>60</Size>
            <RegionId>cn-heyuan</RegionId>
            <ZoneId>cn-heyuan-i</ZoneId>
            <AttachedTime>2021-06-07T06:08:56Z</AttachedTime>
            <Category>cloud_essd</Category>
            <MultiAttach>Disabled</MultiAttach>
            <Tags>
                <TagValue>TestValue</TagValue>
                <TagKey>TestKey</TagKey>
            </Tags>
            <DiskChargeType>PrePaid</DiskChargeType>
            <IOPS>4000</IOPS>
        </Disk>
    </Disks>
</DescribeDedicatedBlockStorageClusterDisksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "11B55F58-D3A4-4A9B-9596-342420D0****",
  "NextToken" : "AAAAAdDWBF2",
  "Disks" : {
    "Disk" : [ {
      "DiskId" : "d-bp67acfmxazb4p****",
      "DiskName" : "testDiskName",
      "Status" : "In_use",
      "Type" : "all",
      "PerformanceLevel" : "PL0",
      "BdfId" : "null",
      "EnableAutoSnapshot" : false,
      "StorageSetId" : "ss-i-bp1j4i2jdf3owlhe****",
      "StorageSetPartitionNumber" : 11,
      "DeleteAutoSnapshot" : false,
      "StorageClusterId" : "dbsc-j5e1sf2vaf5he8m2****",
      "Encrypted" : false,
      "IOPSRead" : 2000,
      "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
    } ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidRegionId.NotFound The specified RegionId does not exist. 指定的RegionId不存在。
404 InvalidZoneId.NotFound The specified ZoneId does not exist. 指定的ZoneId不存在。
404 NoSuchResource The specified resource does not exist. 指定的资源不存在。
504 RequestTimeout The request is timeout, please try again later. 该请求超时,请稍后再重试。
500 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误。
403 InvalidPayMethod The specified pay method is not valid. 不支持该购买方式。请检查您传入的参数chargeType是否正确。
403 Forbidden User is not authorized to operate. 当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403 Forbidden.Action User is not authorized to operate this action. 当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
403 NoPermission.SLR The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS. 当前用户无权限创建SLR。
403 LastTokenProcessing The last token request is processing. 相同clientToken的请求正在执行,请稍后再重试。
403 InvalidAccountStatus.NotEnoughBalance Your account does not have enough balance. 您的账户余额不足。
403 OperationDenied.QuotaExceed The operation is not allowed due to quota exceed. 当前操作已超过使用配额。
403 NotOnSale.Region The specified region is not on sale. 当前Region停售或无库存。
403 NotOnSale.Zone The specified zone is not on sale. 当前Zone停售或无库存。

访问错误中心查看更多错误码。