Queries the created dedicated block storage clusters.
Description
- You can specify multiple request parameters to be queried. Specified parameters have logical AND relations. Only the specified parameters are included in the filter conditions.
- We recommend that you use the NextToken and MaxResults parameters for a paged query. During a paged query, when you call the DescribeDedicatedBlockStorageClusters operation to retrieve the first page of results, set MaxResults to specify the maximum number of entries to return in the call. The return value of NextToken is a pagination token, which can be used in the next call 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 returned in the previous call and set MaxResults to specify the maximum number of entries to return in this call.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDedicatedBlockStorageClusters |
The operation that you want to perform. Set the value to DescribeDedicatedBlockStorageClusters. |
RegionId | String | Yes | cn-heyuan |
The region ID of the dedicated block storage cluster. You can call the DescribeRegions operation to query the most recent region list. |
ZoneId | String | No | cn-heyuan-b |
The zone ID of the dedicated block storage cluster. You can call the DescribeZones operation to query the most recent zone list. |
Category | String | No | cloud_essd |
The category of disks that can be created in the dedicated block storage cluster. Valid value: cloud_essd. Only enhanced SSDs (ESSDs) can be created in dedicated block storage clusters. |
NextToken | String | No | AAAAAdDWBF2 |
The pagination token. Set the value to the NextToken value returned from a previous call to the DescribeDedicatedBlockStorageClusters operation. Leave this parameter empty when you call this operation for the first time. |
MaxResults | Integer | No | 10 |
The maximum number of entries to return on each page. Maximum value: 500. Default value: 10. |
DedicatedBlockStorageClusterId.N | String | No | dbsc-f8z4d3k4nsgg9okb**** |
The ID of dedicated block storage cluster N. You can specify multiple cluster IDs. |
Status.N | String | No | Running |
The state of the dedicated block storage clusters. Valid values:
Valid value of N: 1 to 4. You can specify multiple cluster states to query dedicated block storage clusters in these states. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
NextToken | String | AAAAAdDWBF2 |
The pagination token returned in this call. |
RequestId | String | 11B55F58-D3A4-4A9B-9596-342420D02FF8 |
The ID of the request. |
DedicatedBlockStorageClusters | Array of DedicatedBlockStorageCluster |
Details about one or more dedicated block storage clusters. |
|
DedicatedBlockStorageCluster | |||
Status | String | Running |
The state of the dedicated block storage clusters. Valid values:
|
Type | String | Standard |
The type of the dedicated block storage cluster. Valid values:
|
Description | String | This is description. |
The description of the dedicated block storage cluster. |
ExpiredTime | String | 2022-03-09 00:00:00 |
The expiration time of the dedicated block storage cluster. |
CreateTime | String | 2021-09-08 16:45:45 |
The time when the dedicated block storage cluster was created. |
ZoneId | String | cn-heyuan-b |
The zone ID of the dedicated block storage cluster. |
Category | String | cloud_essd |
The category of the disks created in the dedicated block storage cluster. |
DedicatedBlockStorageClusterName | String | myDBSCCluster |
The name of the dedicated block storage cluster. |
DedicatedBlockStorageClusterId | String | dbsc-f8z4d3k4nsgg9okb**** |
The ID of the dedicated block storage cluster. |
DedicatedBlockStorageClusterCapacity | Object |
The storage capacity of the dedicated block storage cluster. |
|
TotalCapacity | Long | 61440 |
The total capacity of the dedicated block storage cluster. Unit: GiB. |
AvailableCapacity | Long | 61440 |
The available capacity of the dedicated block storage cluster. Unit: GiB. |
Examples
Sample requests
https://ecs.aliyuncs.com/?Action=DescribeDedicatedBlockStorageClusters
&RegionId=cn-heyuan
&&DedicatedBlockStorageClusterId.1=dbsc-f8z4d3k4nsgg9okb****
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDedicatedBlockStorageClustersResponse>
<DedicatedBlockStorageClusters>
<DedicatedBlockStorageCluster>
<Status>Running</Status>
<Type>Standard</Type>
<Category>cloud_essd</Category>
<Description>This is description.</Description>
<ZoneId>cn-heyuan-b</ZoneId>
<DedicatedBlockStorageClusterId>dbsc-f8z4d3k4nsgg9okb****</DedicatedBlockStorageClusterId>
<ExpiredTime>2022-03-09 00:00:00</ExpiredTime>
<CreateTime>2021-09-08 16:45:45</CreateTime>
<DedicatedBlockStorageClusterName>myDBSCCluster</DedicatedBlockStorageClusterName>
<DedicatedBlockStorageClusterCapacity>
<AvailableCapacity>61440</AvailableCapacity>
<TotalCapacity>61440</TotalCapacity>
</DedicatedBlockStorageClusterCapacity>
</DedicatedBlockStorageCluster>
</DedicatedBlockStorageClusters>
<NextToken>AAAAAdDWBF2</NextToken>
<RequestId>11B55F58-D3A4-4A9B-9596-342420D02FF8</RequestId>
</DescribeDedicatedBlockStorageClustersResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"DedicatedBlockStorageClusters" : {
"DedicatedBlockStorageCluster" : [ {
"Status" : "Running",
"Type" : "Standard",
"Category" : "cloud_essd",
"Description" : "This is description.",
"ZoneId" : "cn-heyuan-b",
"DedicatedBlockStorageClusterId" : "dbsc-f8z4d3k4nsgg9okb****",
"ExpiredTime" : "2022-03-09 00:00:00",
"CreateTime" : "2021-09-08 16:45:45",
"DedicatedBlockStorageClusterName" : "myDBSCCluster",
"DedicatedBlockStorageClusterCapacity" : {
"AvailableCapacity" : 61440,
"TotalCapacity" : 61440
}
} ]
},
"NextToken" : "AAAAAdDWBF2",
"RequestId" : "11B55F58-D3A4-4A9B-9596-342420D02FF8"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
403 | InvalidStatus.ValueNotSupported | %s | The error message returned because the operation is not supported while the resource is in the current state. |
404 | InvalidRegionId.NotFound | The specified region does not exist. | The error message returned because the specified RegionId parameter does not exist. Check whether the service is available in the specified region. |
404 | InvalidZoneId.NotFound | The specified zone does not exist. | The error message returned because the specified ZoneId parameter does not exist. |
For a list of error codes, visit the API Error Center.