本接口用于查询存储容量单位包SCU(Storage Capacity Unit)的详细信息列表,支持根据名称、状态以及容量大小等条件进行查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:DescribeStorageCapacityUnits |
get |
StorageCapacityUnit
StorageCapacityUnit
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
SCU 所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| PageNumber |
integer |
否 |
SCU 列表的页码。 起始值:1。 默认值:1。 |
1 |
| PageSize |
integer |
否 |
分页查询时的每页行数。 最大值:100。 默认值:10。 |
1 |
| Name |
string |
否 |
SCU 的名称,长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以 |
testScuName |
| Capacity |
integer |
否 |
SCU 容量大小,单位为 GiB。取值范围:{20, 40, 100, 200, 500, 1024, 2048, 5120, 10240, 20480, 51200}。 |
20 |
| AllocationType |
string |
否 |
分配类型。取值范围:
默认值:Normal。 |
Normal |
| StorageCapacityUnitId |
array |
否 |
SCU 的 ID 数组。数组长度:1~100。 |
scu-bp67acfmxazb4p**** |
|
string |
否 |
SCU 的 ID。 |
scu-bp67acfmxazb4p**** |
|
| Status |
array |
否 |
SCU 的状态数组,数组长度为 1~4。 |
Active |
|
string |
否 |
SCU 的状态值。状态的取值范围:
|
Active |
|
| Tag |
array<object> |
否 |
标签数组。数组长度:0~20。 |
|
|
object |
否 |
|||
| Key |
string |
否 |
SCU 的标签键。 |
TestKey |
| Value |
string |
否 |
SCU 的标签值。 |
TestValue |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| PageSize |
integer |
分页查询时的每页行数。 |
10 |
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| PageNumber |
integer |
SCU 列表的页码。 |
1 |
| TotalCount |
integer |
SCU 总数。 |
1 |
| StorageCapacityUnits |
object |
||
| StorageCapacityUnit |
array<object> |
由 StorageCapacityUnits 组成的数组格式,返回的 SCU 详细信息集合。 |
|
|
array<object> |
|||
| CreationTime |
string |
SCU 的创建时间。 |
2021-08-17T02:55Z |
| Status |
string |
SCU 的状态。可能值:
|
Active |
| StartTime |
string |
SCU 的开始生效时间。 |
2021-08-17T02:55Z |
| Capacity |
integer |
SCU 的容量。 |
20 |
| Description |
string |
SCU 的描述信息。 |
testScuDescription |
| AllocationStatus |
string |
当 AllocationType 值为 Shared 时,该参数表示 SCU 的分配状态。可能值:
|
allocated |
| ExpiredTime |
string |
SCU 的到期时间。 |
2021-09-17T16:00Z |
| StorageCapacityUnitId |
string |
SCU 的 ID。 |
scu-bp67acfmxazb4p**** |
| Name |
string |
SCU 的名称。 |
testScuName |
| RegionId |
string |
SCU 的所属地域 ID。 |
cn-hangzhou |
| Tags |
object |
||
| Tag |
array<object> |
SCU 标签键值对。 |
|
|
object |
|||
| TagValue |
string |
SCU 的标签值。 |
TestKey |
| TagKey |
string |
SCU 的标签键。 |
TestValue |
示例
正常返回示例
JSON格式
{
"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"
}
]
}
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | MissingParameter.RegionId | The specified RegionId should not be null. | RegionId是必选参数。 |
| 400 | InvalidParameter.Name | The specified Name is invalid. | 指定的 Name 参数无效。 |
| 400 | InvalidParameter.CapacityExceed | The specified Capacity exceeds the limitation of quota. | 指定的 Capacity 参数超出了最大有效取值。 |
| 400 | InvalidAllocationType.ValueNotSupported | The specified AllocationType is not supported. | 指定的分配类型无效。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。