全部产品
Search
文档中心

云服务器 ECS:DescribeStorageCapacityUnits

更新时间:Sep 11, 2023

调用DescribeStorageCapacityUnits查询一个或多个存储容量单位包SCU的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeStorageCapacityUnits

系统规定参数。取值:DescribeStorageCapacityUnits

RegionId String cn-hangzhou

SCU所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

PageNumber Integer 1

SCU列表的页码。

起始值:1。

默认值:1。

PageSize Integer 1

分页查询时的每页行数。

最大值:100。

默认值:10。

Name String testScuName

SCU的名称,长度为2~128个英文或中文字符。必须以大小写字母或中文开头,不能以http://或https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

Capacity Integer 20

SCU容量大小,单位为GiB。取值范围:{20, 40, 100, 200, 500, 1024, 2048, 5120, 10240, 20480, 51200}。

AllocationType String Normal

分配类型。取值范围:

  • Normal:查询当前阿里云账号下的SCU。
  • Shared:查询已经建立阿里云账号与RAM用户共享的SCU。

默认值:Normal。

StorageCapacityUnitId.N String scu-bp67acfmxazb4p****

一个或多个SCU ID。N的取值范围:1~100。

Status.N String Active

一个或多个SCU的状态值,N取值范围为1~4。状态的取值范围:

  • Creating:创建中
  • Active:启用中
  • Expired:已过期
  • Pending:待生效
Tag.N.Key String TestKey

SCU的标签键。N表示可以设置多个标签键进行查询,N的取值范围:1~20。

Tag.N.Value String TestValue

SCU的标签值。N表示可以设置多个标签值进行查询,且与Tag.N.Key的N对应,N的取值范围:1~20。

返回数据

名称

类型

示例值

描述

PageSize Integer 10

分页查询时的每页行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

PageNumber Integer 1

SCU列表的页码。

TotalCount Integer 1

SCU总数。

StorageCapacityUnits Array of StorageCapacityUnit

由StorageCapacityUnits组成的数组格式,返回SCU的详细信息。

StorageCapacityUnit
CreationTime String 2021-08-17T02:55Z

SCU的创建时间。

Status String Active

SCU的状态。

StartTime String 2021-08-17T02:55Z

SCU的开始生效时间。

Capacity Integer 20

SCU的容量。

Description String testScuDescription

SCU的描述信息。

AllocationStatus String allocated

当AllocationType值为Shared时,该参数表示SCU的分配状态。可能值:

  • allocated:已分配给其他用户的SCU。
  • beAllocated:被其他用户分配的SCU。
ExpiredTime String 2021-09-17T16:00Z

SCU的到期时间。

StorageCapacityUnitId String scu-bp67acfmxazb4p****

SCU的ID。

Name String testScuName

SCU的名称。

RegionId String cn-hangzhou

SCU的所属地域ID。

Tags Array of Tag

SCU标签键值对。

Tag
TagValue String TestKey

SCU的标签值。

TagKey String TestValue

SCU的标签键。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeStorageCapacityUnits
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeStorageCapacityUnitsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageNumber>1</PageNumber>
    <StorageCapacityUnits>
        <StorageCapacityUnit>
            <Status>Active</Status>
            <Description>testScuDescription</Description>
            <AllocationStatus/>
            <Capacity>20</Capacity>
            <StorageCapacityUnitId>scu-bp67acfmxazb4p****</StorageCapacityUnitId>
            <ExpiredTime>2021-09-17T16:00Z</ExpiredTime>
            <CreationTime>2021-08-17T02:55Z</CreationTime>
            <StartTime>2021-08-17T02:00Z</StartTime>
            <RegionId>cn-hangzhou</RegionId>
            <Tags>
                <Tag>
                    <TagKey>TestKey</TagKey>
                    <TagValue>TestValue</TagValue>
                </Tag>
            </Tags>
            <Name>testScuName</Name>
        </StorageCapacityUnit>
    </StorageCapacityUnits>
</DescribeStorageCapacityUnitsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber" : 1,
  "StorageCapacityUnits" : {
    "StorageCapacityUnit" : [ {
      "Status" : "Active",
      "Description" : "testScuDescription",
      "AllocationStatus" : "",
      "Capacity" : 20,
      "StorageCapacityUnitId" : "scu-bp67acfmxazb4p****",
      "ExpiredTime" : "2021-09-17T16:00Z",
      "CreationTime" : "2021-08-17T02:55Z",
      "StartTime" : "2021-08-17T02:00Z",
      "RegionId" : "cn-hangzhou",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "TestKey",
          "TagValue" : "TestValue"
        } ]
      },
      "Name" : "testScuName"
    } ]
  }
}

错误码

HttpCode

错误码

错误信息

描述

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. 指定的分配类型无效。

访问错误中心查看更多错误码。