All Products
Search
Document Center

Elastic Compute Service:DescribeDedicatedBlockStorageClusters

Last Updated:Sep 25, 2024

Queries the dedicated block storage clusters that are created.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ebs:DescribeDedicatedBlockStorageClustersget
  • DedicatedBlockStorageCluster
    acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/*
  • DedicatedBlockStorageCluster
    acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the dedicated block storage cluster. You can call the DescribeRegions operation to query the most recent region list.

cn-heyuan
AzoneIdstringNo

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
DedicatedBlockStorageClusterIdarrayNo

The IDs of the dedicated block storage clusters. You can specify the IDs of multiple dedicated block storage clusters in a request.

DbscIdstringNo

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****
StatusarrayNo

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.

StatustringNo

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
CategorystringNo

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
Tagarray<object>No

The tags. Up to 20 tags are supported.

objectNo
KeystringNo

The tag key of the dedicated block storage cluster.

TestKey
ValuestringNo

The tag value of the dedicated block storage cluster.

TestValue
ResourceGroupIdstringNo

The ID of the resource group to which the dedicated block storage cluster belongs.

rg-acfmvs4****
NextTokenstringNo

The query token. Set the value to the NextToken value that is returned in the last call.

AAAAAdDWBF2
MaxResultsintegerNo

The maximum number of entries to return in each request that uses a token to perform a query.

10
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 100.

10
PageNumberintegerNo

The page number.

1
ClientTokenstringNo

A string generated by the server as an identifier for clients to send requests.

123e4567-e89b-12d3-a456-426655440000

Response parameters

ParameterTypeDescriptionExample
object

The response.

DedicatedBlockStorageClustersarray<object>

Details about the dedicated block storage clusters.

Dbscobject
DedicatedBlockStorageClusterIdstring

The ID of the dedicated block storage cluster.

dbsc-f8z4d3k4nsgg9okb****
DedicatedBlockStorageClusterNamestring

The name of the dedicated block storage cluster.

myDBSCCluster
Descriptionstring

The description of the dedicated block storage cluster.

This is description.
RegionIdstring

The region ID of the dedicated block storage cluster.

cn-heyuan
ZoneIdstring

The zone ID of the dedicated block storage cluster.

cn-heyuan-b
Statusstring

The state of the dedicated block storage cluster. Valid values:

  • Preparing
  • Running
  • Expired
  • Offline
Running
Categorystring

The category of disks that can be created in the dedicated block storage cluster.

cloud_essd
Typestring

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
PerformanceLevelstring

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
SupportedCategorystring

This parameter is not supported.

cloud_essd
CreateTimestring

The time when the dedicated block storage cluster was created. The value is a UNIX timestamp. Unit: seconds.

1657113211
ExpiredTimestring

The time when the dedicated block storage cluster expires. The value is a UNIX timestamp. Unit: seconds.

1673020800
DedicatedBlockStorageClusterCapacityobject

Details about the storage capacity of the dedicated block storage cluster.

AvailableCapacitylong

The available capacity of the dedicated block storage cluster. Unit: GiB.

61440
TotalCapacitylong

The total capacity of the dedicated block storage cluster. Unit: GiB.

61440
DeliveryCapacitylong

The capacity to be delivered for the dedicated block storage cluster. Unit: GiB.

0
UsedCapacitylong

The used capacity of the dedicated block storage cluster. Unit: GiB.

1440
ClusterDeliveryCapacitylong

The capacity of the dedicated block storage cluster that is to be delivered in orders. Unit: GB.

0
ClusterAvailableCapacitylong

The capacity of the dedicated block storage cluster that was delivered in orders. Unit: GB.

61440
AvailableDeviceCapacitylong

The total capacity of the dedicated block storage cluster that was delivered in disk creation orders. Unit: GB.

61440
TotalDeviceCapacitylong

The total capacity of the dedicated block storage cluster that is to be delivered in disk creation orders. Unit: GB.

61440
UsedDeviceCapacitylong

The capacity of the dedicated block storage cluster that was used to create disks. Unit: GB.

32000
AvailableSpaceCapacitydouble

This parameter is displayed only if Thin Provision is enabled.

40000.3
TotalSpaceCapacitylong

This parameter is displayed only if Thin Provision is enabled.

73728
UsedSpaceCapacitydouble

This parameter is displayed only if Thin Provision is enabled.

33727.7
AliUidstring

The user ID.

12345601234560***
StorageDomainstring

StorageDomain

StorageDomain
EnableThinProvisionboolean

Indicates whether Thin Provision is enabled.

true
SizeOverSoldRatiodouble

The capacity oversold ratio.

1.2
Tagsarray<object>

The tags of the dedicated block storage cluster.

Tagobject
TagKeystring

The tag key of the dedicated block storage cluster.

testKey
TagValuestring

The tag value of the dedicated block storage cluster.

testValue
ResourceGroupIdstring

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****
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

AAAAAdDWBF2
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountlong

The total number of entries returned.

20
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.The parameter must be specified.
403ForbiddenUser is not authorized to operate.You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403Forbidden.ActionUser is not authorized to operate this action.You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
403InvalidDiskCategory.NotSupportedThe specified disk category is not supported.-
403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.You are not authorized to create service-linked roles.
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.-
404InvalidRegionId.NotFoundThe specified RegionId does not exist.-
404InvalidResourceId.NotFoundThe specified ResourceIds are not found in our records.-
404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.-
404InvalidZoneId.NotFoundThe specified ZoneId does not exist.-
404NoSuchResourceThe specified resource does not exist.The specified resource does not exist.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred.
504RequestTimeoutThe request is timeout, please try again later.The request has timed out. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-05The Error code has changed. The response structure of the API has changedView Change Details
2022-12-08The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details