调用DescribeDedicatedBlockStorageClusters查询已创建的专属块存储集群列表。

接口说明

说明 专属块存储集群功能目前支持华南2(河源)、印度尼西亚(雅加达)以及金融云的华南1(深圳)地域。
  • 请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。
  • 在分页查询时,推荐您使用MaxResults与NextToken参数进行查询。具体使用说明:分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置MaxResults限制返回条目数。

调试

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

请求参数

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

系统规定参数。取值:DescribeDedicatedBlockStorageClusters

RegionId String cn-heyuan

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ZoneId String cn-heyuan-b

可用区ID,您可以调用DescribeZones获取可用区列表。

Category String cloud_essd

专属块存储集群可创建的云盘类型。

取值仅支持cloud_essd,即ESSD云盘。

NextToken String AAAAAdDWBF2

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

MaxResults Integer 10

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

默认值:10

DedicatedBlockStorageClusterId.N String dbsc-f8z4d3k4nsgg9okb****

专属块存储集群ID。支持同时指定多个集群ID进行查询。

Status.N String Running

专属块存储集群的状态。取值范围:

  • Preparing:待交付
  • Running:运行中
  • Expired:集群到期
  • Offline:下线

N表示可同时设置多个状态,N的取值范围为1~4。

返回数据

名称 类型 示例值 描述
NextToken String AAAAAdDWBF2

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

RequestId String 11B55F58-D3A4-4A9B-9596-342420D02FF8

请求ID。

DedicatedBlockStorageClusters Array of DedicatedBlockStorageCluster

由一个或多个专属块存储集群信息组成的数组。

DedicatedBlockStorageCluster
Status String Running

专属块存储集群的状态。可能值:

  • Preparing:待交付
  • Running:运行中
  • Expired:集群到期
  • Offline:下线
Type String Standard

专属块存储集群性能类型。可能值:

  • Standard:基础型。该类型的专属块存储集群中可创建ESSD PL0云盘。
  • Premium:性能型。该类型的专属块存储集群中可创建ESSD PL1云盘。
Description String This is description.

专属块存储集群的描述信息。

ExpiredTime String 2022-03-09 00:00:00

专属块存储集群到期时间。

CreateTime String 2021-09-08 16:45:45

专属块存储集群创建时间。

ZoneId String cn-heyuan-b

集群所属的可用区ID。

Category String cloud_essd

专属块存储集群可创建的云盘类型。

DedicatedBlockStorageClusterName String myDBSCCluster

专属块存储集群名称。

DedicatedBlockStorageClusterId String dbsc-f8z4d3k4nsgg9okb****

专属块存储集群ID。

DedicatedBlockStorageClusterCapacity Object

专属块存储集群的存储容量信息。

TotalCapacity Long 61440

当前集群总容量,单位为GiB。

AvailableCapacity Long 61440

当前集群可用的容量,单位为GiB。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeDedicatedBlockStorageClusters
&RegionId=cn-heyuan
&&DedicatedBlockStorageClusterId.1=dbsc-f8z4d3k4nsgg9okb****
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeDedicatedBlockStorageClustersResponse>
    <DedicatedBlockStorageClusters>
        <DedicatedBlockStorageCluster>
            <Status>Running</Status>
            <Type>Standard</Type>
            <Category>cloud_essd</Category>
            <Description>This is description.</Description>
            <ZoneId>cn-heyuan-b</ZoneId>
            <DedicatedBlockStorageClusterId>dbsc-f8z4d3k4nsgg9okb****</DedicatedBlockStorageClusterId>
            <ExpiredTime>2022-03-09 00:00:00</ExpiredTime>
            <CreateTime>2021-09-08 16:45:45</CreateTime>
            <DedicatedBlockStorageClusterName>myDBSCCluster</DedicatedBlockStorageClusterName>
            <DedicatedBlockStorageClusterCapacity>
                <AvailableCapacity>61440</AvailableCapacity>
                <TotalCapacity>61440</TotalCapacity>
            </DedicatedBlockStorageClusterCapacity>
        </DedicatedBlockStorageCluster>
    </DedicatedBlockStorageClusters>
    <NextToken>AAAAAdDWBF2</NextToken>
    <RequestId>11B55F58-D3A4-4A9B-9596-342420D02FF8</RequestId>
</DescribeDedicatedBlockStorageClustersResponse>

JSON格式

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

{
  "DedicatedBlockStorageClusters" : {
    "DedicatedBlockStorageCluster" : [ {
      "Status" : "Running",
      "Type" : "Standard",
      "Category" : "cloud_essd",
      "Description" : "This is description.",
      "ZoneId" : "cn-heyuan-b",
      "DedicatedBlockStorageClusterId" : "dbsc-f8z4d3k4nsgg9okb****",
      "ExpiredTime" : "2022-03-09 00:00:00",
      "CreateTime" : "2021-09-08 16:45:45",
      "DedicatedBlockStorageClusterName" : "myDBSCCluster",
      "DedicatedBlockStorageClusterCapacity" : {
        "AvailableCapacity" : 61440,
        "TotalCapacity" : 61440
      }
    } ]
  },
  "NextToken" : "AAAAAdDWBF2",
  "RequestId" : "11B55F58-D3A4-4A9B-9596-342420D02FF8"
}

错误码

HttpCode 错误码 错误信息 描述
403 InvalidStatus.ValueNotSupported %s 该资源当前的状态不支持此操作。
404 InvalidRegionId.NotFound The specified region does not exist. 指定的 RegionId 不存在,请您检查此产品在该地域是否可用。
404 InvalidZoneId.NotFound The specified zone does not exist. 指定的可用区ID不存在。

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