DescribeDedicatedBlockStorageClusters - 查询专属块存储集群 - 云服务器 ECS

查询专属集群OpenApi

接口说明

说明

专属块存储集群功能目前支持华南 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:DescribeDedicatedBlockStorageClusters

get

*DedicatedBlockStorageCluster

acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/*

*DedicatedBlockStorageCluster

acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-heyuan
AzoneId	string	否	可用区 ID，您可以调用 DescribeZones 获取可用区列表。	cn-heyuan-b
DedicatedBlockStorageClusterId	array	否	由一个或多个专属块存储集群 id 组成的数组格式
	string	否	专属块存储集群 id	dbsc-cn-jaj3cli530g
Status	array	否	专属块存储集群的状态。取值范围： Preparing：待交付。 Running：运行中。 Expired：集群到期。 Offline：下线。可同时设置多个状态，取值范围为 1~4。枚举值： Running : Running Offline : Offline Expired : Expired Preparing : Preparing
	string	否	专属块存储集群的状态。取值范围： Preparing：待交付。 Running：运行中。 Expired：集群到期。 Offline：下线。 N 表示可同时设置多个状态，N 的取值范围为 1~4。	Running
Category	string	否	专属块存储集群可创建的云盘类型。取值仅支持 cloud_essd，即 ESSD 云盘。	cloud_essd
Tag	array<object>	否	标签列表，最多包含 20 个子项。
	object	否	标签信息。
Key	string	否	专属集群的标签键。	TestKey
Value	string	否	专属集群的标签值。	TestValue
ResourceGroupId	string	否	专属集群所在的企业资源组 ID。您可以调用 ListResourceGroups 查询资源组 ID。	rg-acfmvs4****
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	2c4d848a9628fb5e
MaxResults	integer	否	Token 方式最大个数。	10
PageSize	integer	否	分页查询时设置的每页行数。取值范围 1-100。	10
PageNumber	integer	否	分页查询时的页码。	1
ClientToken	string	否	服务端生成的一串字符串，作为客户端进行请求的一个标识。	123e4567-e89b-12d3-a456-426655440000

返回参数

名称	类型	描述	示例值
	object	Schema of Response
DedicatedBlockStorageClusters	array<object>	由一个或多个专属块存储集群信息组成的数组。
	array<object>	由一个或多个专属块存储集群信息组成的数组。
DedicatedBlockStorageClusterId	string	专属块存储集群 ID。	dbsc-f8z4d3k4nsgg9okb****
DedicatedBlockStorageClusterName	string	专属块存储集群名称。	myDBSCCluster
Description	string	专属块存储集群的描述信息。	This is description.
RegionId	string	专属块存储集群所在地域 ID。	cn-heyuan
ZoneId	string	专属块存储集群所属的可用区 ID。	cn-heyuan-b
Status	string	专属块存储集群的状态。可能值： Preparing：待交付。 Running：运行中。 Expired：集群到期。 Offline：下线。	Running
Category	string	专属块存储集群可创建的云盘类型。	cloud_essd
Type	string	专属块存储集群性能类型。可能值： Standard：基础型。该类型的专属块存储集群中可创建 ESSD PL0 云盘。 Premium：性能型。该类型的专属块存储集群中可创建 ESSD PL1 云盘。	Standard
PerformanceLevel	string	云盘性能等级，可能值： PL0 。 PL1 。 PL2 。 PL3。说明仅在 SupportedCategory=cloud_essd 有效。	PL0
SupportedCategory	string	暂未支持该参数。	cloud_essd
CreateTime	string	专属块存储集群创建时间，格式为 Unix 时间戳，单位为秒。	1657113211
ExpiredTime	string	专属块存储集群到期时间，格式为 Unix 时间戳，单位为秒。	1673020800
DedicatedBlockStorageClusterCapacity	object	专属块存储集群的存储容量信息。
AvailableCapacity	integer	专属块存储集群的可用容量，单位为 GiB。	61440
TotalCapacity	integer	专属块存储集群的总容量，单位为 GiB。	61440
DeliveryCapacity	integer	待交付容量，单位为 GiB。	0
UsedCapacity	integer	当前集群的已使用（已创盘）容量，单位为 GiB。	1440
ClusterDeliveryCapacity	integer	待交付专属集群订单容量，单位为 GB	0
ClusterAvailableCapacity	integer	已交付专属集群订单容量，单位为 GB	61440
AvailableDeviceCapacity	integer	当前集群允许创盘总容量（已交付订单容量），单位为 GB	61440
TotalDeviceCapacity	integer	当前集群总创盘容量（已下单订单容量），单位为 GB	61440
UsedDeviceCapacity	integer	实际创盘容量，单位为 GB	32000
AvailableSpaceCapacity	number	开启精简配置后显示	40000.3
TotalSpaceCapacity	integer	开启精简配置后显示	73728
UsedSpaceCapacity	number	开启精简配置后显示	33727.7
AliUid	string	用户 id	1234560123456****
StorageDomain	string	StorageDomain	StorageDomain
EnableThinProvision	boolean	开启精简配置	true
SizeOverSoldRatio	number	容量超卖系数	1.2
Tags	array<object>	专属集群的标签。
	object	标签信息。
TagKey	string	专属集群的标签键。	testKey
TagValue	string	专属集群的标签值。	testValue
ResourceGroupId	string	专属集群所在的企业资源组 ID。您可以调用 ListResourceGroups 查询资源组 ID。	rg-aekzsoux****
NextToken	string	本次调用返回的查询凭证值。	AAAAAdDWBF2
PageNumber	integer	参数页码。	1
PageSize	integer	参数页行数。	10
TotalCount	integer	分页查询时的结果总条数。	20
RequestId	string	请求 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": "1234560123456****",
      "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	错误码	错误信息
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
403	InvalidDiskCategory.NotSupported	The specified disk category is not supported.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.
404	InvalidZoneId.NotFound	The specified ZoneId does not exist.
404	NoSuchResource	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.

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

变更历史

更多信息，参考变更详情。