Queries dedicated clusters.
Operation description
Usage notes
- 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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| 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. | |
| DbscId | 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:
Multiple states can be specified. Valid values of N: 1, 2, 3, and 4. | |
| Statu | string | No | The state of the dedicated block storage cluster. Valid values:
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 parameters
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 code | Error code | Error message | Description |
|---|---|---|---|
| 400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. | The parameter must be specified. |
| 403 | Forbidden | User is not authorized to operate. | You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account. |
| 403 | Forbidden.Action | User 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. |
| 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. | You are not authorized to create service-linked roles. |
| 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. | The specified resource does not exist. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error has occurred. |
| 504 | RequestTimeout | The 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 time | Summary of changes | Operation |
|---|---|---|
| 2023-09-05 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2022-12-08 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |