文档

DescribeDedicatedBlockStorageClusters - 查询专属块存储集群

更新时间:

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ebs:DescribeDedicatedBlockStorageClustersRead
  • DedicatedBlockStorageCluster
    acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/*
  • DedicatedBlockStorageCluster
    acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-heyuan
AzoneIdstring

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

cn-heyuan-b
DedicatedBlockStorageClusterIdarray

由一个或多个专属块存储集群 id 组成的数组格式

string

专属块存储集群 id

dbsc-cn-jaj3cli530g
Statusarray

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

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

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

string

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

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

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

Running
Categorystring

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

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

cloud_essd
Tagobject []

标签列表,最多包含 20 个子项。

Keystring

专属集群的标签键。

TestKey
Valuestring

专属集群的标签值。

TestValue
ResourceGroupIdstring

专属集群所在的企业资源组 ID。您可以调用 ListResourceGroups 查询资源组 ID。

rg-acfmvs4****
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

2c4d848a9628fb5e
MaxResultsinteger

Token 方式最大个数。

10
PageSizeinteger

分页查询时设置的每页行数。 取值范围 1-100。

10
PageNumberinteger

分页查询时的页码。

1
ClientTokenstring

服务端生成的一串字符串,作为客户端进行请求的一个标识。

123e4567-e89b-12d3-a456-426655440000

返回参数

名称类型描述示例值
object

Schema of Response

DedicatedBlockStorageClustersobject []

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

DedicatedBlockStorageClusterIdstring

专属块存储集群 ID。

dbsc-f8z4d3k4nsgg9okb****
DedicatedBlockStorageClusterNamestring

专属块存储集群名称。

myDBSCCluster
Descriptionstring

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

This is description.
RegionIdstring

专属块存储集群所在地域 ID。

cn-heyuan
ZoneIdstring

专属块存储集群所属的可用区 ID。

cn-heyuan-b
Statusstring

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

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

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

cloud_essd
Typestring

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

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

云盘性能等级,可能值:

  • PL0 。
  • PL1 。
  • PL2 。
  • PL3。
说明 仅在 SupportedCategory=cloud_essd 有效。
PL0
SupportedCategorystring

暂未支持该参数。

cloud_essd
CreateTimestring

专属块存储集群创建时间,格式为 Unix 时间戳,单位为秒。

1657113211
ExpiredTimestring

专属块存储集群到期时间,格式为 Unix 时间戳,单位为秒。

1673020800
DedicatedBlockStorageClusterCapacityobject

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

AvailableCapacitylong

专属块存储集群的可用容量,单位为 GiB。

61440
TotalCapacitylong

专属块存储集群的总容量,单位为 GiB。

61440
DeliveryCapacitylong

待交付容量,单位为 GiB。

0
UsedCapacitylong

当前集群的已使用(已创盘)容量,单位为 GiB。

1440
ClusterDeliveryCapacitylong

待交付专属集群订单容量,单位为 GB

0
ClusterAvailableCapacitylong

已交付专属集群订单容量,单位为 GB

61440
AvailableDeviceCapacitylong

当前集群允许创盘总容量(已交付订单容量),单位为 GB

61440
TotalDeviceCapacitylong

当前集群总创盘容量(已下单订单容量),单位为 GB

61440
UsedDeviceCapacitylong

实际创盘容量,单位为 GB

32000
AvailableSpaceCapacitydouble

开启精简配置后显示

40000.3
TotalSpaceCapacitylong

开启精简配置后显示

73728
UsedSpaceCapacitydouble

开启精简配置后显示

33727.7
AliUidstring

用户 id

12345601234560123
StorageDomainstring

StorageDomain

StorageDomain
EnableThinProvisionboolean

开启精简配置

true
SizeOverSoldRatiodouble

容量超卖系数

1.2
Tagsobject []

专属集群的标签。

TagKeystring

专属集群的标签键。

testKey
TagValuestring

专属集群的标签值。

testValue
ResourceGroupIdstring

专属集群所在的企业资源组 ID。您可以调用 ListResourceGroups 查询资源组 ID。

rg-aekzsoux****
NextTokenstring

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

AAAAAdDWBF2
PageNumberinteger

参数页码。

1
PageSizeinteger

参数页行数。

10
TotalCountlong

分页查询时的结果总条数。

20
RequestIdstring

请求 ID。

11B55F58-D3A4-4A9B-9596-342420D0****

示例

正常返回示例

JSON格式

{
  "DedicatedBlockStorageClusters": [
    {
      "DedicatedBlockStorageClusterId": "dbsc-f8z4d3k4nsgg9okb****",
      "DedicatedBlockStorageClusterName": "myDBSCCluster",
      "Description": "This is description.",
      "RegionId": "cn-heyuan",
      "ZoneId": "cn-heyuan-b",
      "Status": "Running",
      "Category": "cloud_essd",
      "Type": "Standard",
      "PerformanceLevel": "PL0",
      "SupportedCategory": "cloud_essd",
      "CreateTime": "1657113211",
      "ExpiredTime": "1673020800",
      "DedicatedBlockStorageClusterCapacity": {
        "AvailableCapacity": 61440,
        "TotalCapacity": 61440,
        "DeliveryCapacity": 0,
        "UsedCapacity": 1440,
        "ClusterDeliveryCapacity": 0,
        "ClusterAvailableCapacity": 61440,
        "AvailableDeviceCapacity": 61440,
        "TotalDeviceCapacity": 61440,
        "UsedDeviceCapacity": 32000,
        "AvailableSpaceCapacity": 40000.3,
        "TotalSpaceCapacity": 73728,
        "UsedSpaceCapacity": 33727.7
      },
      "AliUid": "12345601234560123",
      "StorageDomain": "StorageDomain",
      "EnableThinProvision": true,
      "SizeOverSoldRatio": 1.2,
      "Tags": [
        {
          "TagKey": "testKey",
          "TagValue": "testValue"
        }
      ],
      "ResourceGroupId": "rg-aekzsoux****"
    }
  ],
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.参数缺失。
403ForbiddenUser is not authorized to operate.当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403Forbidden.ActionUser is not authorized to operate this action.当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
403InvalidDiskCategory.NotSupportedThe specified disk category is not supported.当前操作不支持您指定的磁盘类型。请检查您的输入参数和API文档。
403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.当前用户无权限创建SLR。
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确,请注意确认大小写。
404InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的RegionId不存在。
404InvalidResourceId.NotFoundThe specified ResourceIds are not found in our records.指定的资源不存在,请检查参数ResourceId是否正确。
404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.指定的资源类型不存在。
404InvalidZoneId.NotFoundThe specified ZoneId does not exist.指定的ZoneId不存在。
404NoSuchResourceThe specified resource does not exist.指定的资源不存在。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
504RequestTimeoutThe request is timeout, please try again later.该请求超时,请稍后再重试。

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

变更历史

变更时间变更内容概要操作
2023-09-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
    删除错误码:504
出参OpenAPI 返回结构发生变更
2022-12-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
    删除错误码:504
入参OpenAPI 入参发生变更
    新增入参:PageNumber
    新增入参:PageSize
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈