Call DescribeDedicatedBlockStorageClusters to query dedicated block storage clusters - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries dedicated clusters.

Operation description

Usage notes

Note

The Dedicated Block Storage Cluster feature is available only in the China (Heyuan), Indonesia (Jakarta), and China (Shenzhen) regions.

You can specify multiple request parameters to be queried. Specified parameters are evaluated by using the AND operator. Only the specified parameters are included in the filter conditions.
We recommend that you use NextToken and MaxResults to perform paged queries. We recommend that you use MaxResults to specify the maximum number of entries to return in each request. The return value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. When you call the DescribeDedicatedBlockStorageClusters operation to retrieve a new page of results, set NextToken to the NextToken value that is returned in the previous call and specify MaxResults to limit the number of entries returned.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ebs:DescribeDedicatedBlockStorageClusters

get

*DedicatedBlockStorageCluster

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

*DedicatedBlockStorageCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the dedicated block storage cluster. You can call the DescribeRegions operation to query the most recent region list.	cn-heyuan
AzoneId	string	No	The zone ID of the dedicated block storage cluster. You can call the DescribeZones operation to query the most recent zone list.	cn-heyuan-b
DedicatedBlockStorageClusterId	array	No	The IDs of the dedicated block storage clusters. You can specify the IDs of multiple dedicated block storage clusters in a request.
	string	No	The ID of dedicated block storage cluster N. You can specify the IDs of multiple dedicated block storage clusters in a single request.	dbsc-f8z4d3k4nsgg9okb****
Status	array	No	The states of dedicated block storage clusters. Valid values: Preparing Running Expired Offline Multiple states can be specified. Valid values of N: 1, 2, 3, and 4. Valid values: Running : Running Offline : Offline Expired : Expired Preparing : Preparing
	string	No	The state of the dedicated block storage cluster. Valid values: Preparing Running Expired Offline N indicates that multiple states can be specified. Valid values of N: 1, 2, 3, and 4.	Running
Category	string	No	The category of disks that can be created in the dedicated block storage cluster. Set the value to cloud_essd. Only enhanced SSDs (ESSDs) can be created in dedicated block storage clusters.	cloud_essd
Tag	array<object>	No	The tags. Up to 20 tags are supported.
	object	No
Key	string	No	The tag key of the dedicated block storage cluster.	TestKey
Value	string	No	The tag value of the dedicated block storage cluster.	TestValue
ResourceGroupId	string	No	The ID of the resource group to which the dedicated block storage cluster belongs.	rg-acfmvs4****
NextToken	string	No	The query token. Set the value to the NextToken value that is returned in the last call.	AAAAAdDWBF2
MaxResults	integer	No	The maximum number of entries to return in each request that uses a token to perform a query.	10
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100.	10
PageNumber	integer	No	The page number.	1
ClientToken	string	No	A string generated by the server as an identifier for clients to send requests.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The response.
DedicatedBlockStorageClusters	array<object>	Details about the dedicated block storage clusters.
	array<object>
DedicatedBlockStorageClusterId	string	The ID of the dedicated block storage cluster.	dbsc-f8z4d3k4nsgg9okb****
DedicatedBlockStorageClusterName	string	The name of the dedicated block storage cluster.	myDBSCCluster
Description	string	The description of the dedicated block storage cluster.	This is description.
RegionId	string	The region ID of the dedicated block storage cluster.	cn-heyuan
ZoneId	string	The zone ID of the dedicated block storage cluster.	cn-heyuan-b
Status	string	The state of the dedicated block storage cluster. Valid values: Preparing Running Expired Offline	Running
Category	string	The category of disks that can be created in the dedicated block storage cluster.	cloud_essd
Type	string	The type of the dedicated block storage cluster. Valid values: Standard: basic dedicated block storage cluster. ESSDs at performance level 0 (PL0 ESSDs) can be created in basic dedicated block storage clusters. Premium: performance dedicated block storage cluster. ESSDs at performance level 1 (PL1 ESSDs) can be created in performance dedicated block storage clusters.	Standard
PerformanceLevel	string	The performance level of disks. Valid values: PL0 PL1 PL2 PL3 Note This parameter is valid only when the SupportedCategory value is cloud_essd.	PL0
SupportedCategory	string	This parameter is not supported.	cloud_essd
CreateTime	string	The time when the dedicated block storage cluster was created. The value is a UNIX timestamp. Unit: seconds.	1657113211
ExpiredTime	string	The time when the dedicated block storage cluster expires. The value is a UNIX timestamp. Unit: seconds.	1673020800
DedicatedBlockStorageClusterCapacity	object	Details about the storage capacity of the dedicated block storage cluster.
AvailableCapacity	integer	The available capacity of the dedicated block storage cluster. Unit: GiB.	61440
TotalCapacity	integer	The total capacity of the dedicated block storage cluster. Unit: GiB.	61440
DeliveryCapacity	integer	The capacity to be delivered for the dedicated block storage cluster. Unit: GiB.	0
UsedCapacity	integer	The used capacity of the dedicated block storage cluster. Unit: GiB.	1440
ClusterDeliveryCapacity	integer	The capacity of the dedicated block storage cluster that is to be delivered in orders. Unit: GB.	0
ClusterAvailableCapacity	integer	The capacity of the dedicated block storage cluster that was delivered in orders. Unit: GB.	61440
AvailableDeviceCapacity	integer	The total capacity of the dedicated block storage cluster that was delivered in disk creation orders. Unit: GB.	61440
TotalDeviceCapacity	integer	The total capacity of the dedicated block storage cluster that is to be delivered in disk creation orders. Unit: GB.	61440
UsedDeviceCapacity	integer	The capacity of the dedicated block storage cluster that was used to create disks. Unit: GB.	32000
AvailableSpaceCapacity	number	This parameter is displayed only if Thin Provision is enabled.	40000.3
TotalSpaceCapacity	integer	This parameter is displayed only if Thin Provision is enabled.	73728
UsedSpaceCapacity	number	This parameter is displayed only if Thin Provision is enabled.	33727.7
AliUid	string	The user ID.	12345601234560***
StorageDomain	string	StorageDomain	StorageDomain
EnableThinProvision	boolean	Indicates whether Thin Provision is enabled.	true
SizeOverSoldRatio	number	The capacity oversold ratio.	1.2
Tags	array<object>	The tags of the dedicated block storage cluster.
	object
TagKey	string	The tag key of the dedicated block storage cluster.	testKey
TagValue	string	The tag value of the dedicated block storage cluster.	testValue
ResourceGroupId	string	The ID of the resource group to which the dedicated block storage cluster belongs. You can call the ListResourceGroups operation to obtain the ID of the resource group.	rg-aekzsoux****
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	AAAAAdDWBF2
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	20
RequestId	string	The request ID.	11B55F58-D3A4-4A9B-9596-342420D0****

Examples

Success response

JSON format

{
  "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": "12345601234560***",
      "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****"
}

Error codes

HTTP status code	Error code	Error message
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.