Queries the details of one or more SCUs.
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 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ecs:DescribeStorageCapacityUnits | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the SCU. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
PageNumber | integer | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Maximum value: 100. Default value: 10. | 1 |
Name | string | No | The name of the SCU. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with | testScuName |
Capacity | integer | No | The capacity of the SCU. Unit: GiB. Valid values: 20, 40, 100, 200, 500, 1024, 2048, 5120, 10240, 20480, and 51200. | 20 |
AllocationType | string | No | The allocation type. Valid values:
Default value: Normal. | Normal |
StorageCapacityUnitId | array | No | One or multiple SCU IDs. You can specify 1 to 100 SCU IDs. | |
string | No | One or multiple SCU IDs. You can specify 1 to 100 SCU IDs. | scu-bp67acfmxazb4p**** | |
Status | array | No | The state of SCUs. You can specify 1 to 4 types of state. Valid values:
| |
string | No | The state of SCUs. You can specify 1 to 4 types of state. Valid values:
| Active | |
Tag | array<object> | No | The tags of the SCUs. | |
object | No | |||
Key | string | No | The key of tag N of the SCU. N is the identifier for the tag, which you can use to set and query the tag. Valid values of N: 1 to 20. | TestKey |
Value | string | No | The value of tag N of the SCU. N is the identifier for the tag, which you can use to set and query the tag. The value of N must coincide with | TestValue |
Response parameters
Examples
Sample success responses
JSON
format
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 1,
"StorageCapacityUnits": {
"StorageCapacityUnit": [
{
"CreationTime": "2021-08-17T02:55Z",
"Status": "Active",
"StartTime": "2021-08-17T02:55Z",
"Capacity": 20,
"Description": "testScuDescription",
"AllocationStatus": "allocated",
"ExpiredTime": "2021-09-17T16:00Z",
"StorageCapacityUnitId": "scu-bp67acfmxazb4p****",
"Name": "testScuName",
"RegionId": "cn-hangzhou",
"Tags": {
"Tag": [
{
"TagValue": "TestKey",
"TagKey": "TestValue"
}
]
}
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | MissingParameter.RegionId | The specified RegionId should not be null. | The RegionId parameter is required. |
400 | InvalidParameter.Name | The specified Name is invalid. | The specified Name parameter is invalid. |
400 | InvalidParameter.CapacityExceed | The specified Capacity exceeds the limitation of quota. | The specified Capacity value exceeds the maximum allowed value. |
400 | InvalidAllocationType.ValueNotSupported | The specified AllocationType is not supported. | The specified AllocationType parameter is invalid. |
For a list of error codes, visit the Service error codes.