全部产品
Search
文档中心

云服务器 ECS:DescribeStorageCapacityUnits - 查询存储容量单位包SCU详细信息

更新时间:Nov 29, 2024

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeStorageCapacityUnitsget
*StorageCapacityUnit
acs:ecs:{#regionId}:{#accountId}:scu/*
*StorageCapacityUnit
acs:ecs:{#regionId}:{#accountId}:scu/{#scuId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
PageNumberinteger

SCU 列表的页码。

起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时的每页行数。

最大值:100。

默认值:10。

1
Namestring

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

testScuName
Capacityinteger

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

20
AllocationTypestring

分配类型。取值范围:

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

默认值:Normal。

Normal
StorageCapacityUnitIdarray

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

string

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

scu-bp67acfmxazb4p****
Statusarray

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

  • Creating:创建中。
  • Active:启用中。
  • Expired:已过期。
  • Pending:待生效。
string

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

  • Creating:创建中
  • Active:启用中
  • Expired:已过期
  • Pending:待生效
Active
Tagarray<object>

标签列表

object
Keystring

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

TestKey
Valuestring

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

TestValue

返回参数

名称类型描述示例值
object
PageSizeinteger

分页查询时的每页行数。

10
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

SCU 列表的页码。

1
TotalCountinteger

SCU 总数。

1
StorageCapacityUnitsarray<object>

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

StorageCapacityUnitobject
CreationTimestring

SCU 的创建时间。

2021-08-17T02:55Z
Statusstring

SCU 的状态。

Active
StartTimestring

SCU 的开始生效时间。

2021-08-17T02:55Z
Capacityinteger

SCU 的容量。

20
Descriptionstring

SCU 的描述信息。

testScuDescription
AllocationStatusstring

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

  • allocated:已分配给其他用户的 SCU。
  • beAllocated:被其他用户分配的 SCU。
allocated
ExpiredTimestring

SCU 的到期时间。

2021-09-17T16:00Z
StorageCapacityUnitIdstring

SCU 的 ID。

scu-bp67acfmxazb4p****
Namestring

SCU 的名称。

testScuName
RegionIdstring

SCU 的所属地域 ID。

cn-hangzhou
Tagsarray<object>

SCU 标签键值对。

Tagobject
TagValuestring

SCU 的标签值。

TestKey
TagKeystring

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错误码错误信息描述
400MissingParameter.RegionIdThe specified RegionId should not be null.RegionId是必选参数。
400InvalidParameter.NameThe specified Name is invalid.指定的 Name 参数无效。
400InvalidParameter.CapacityExceedThe specified Capacity exceeds the limitation of quota.指定的 Capacity 参数超出了最大有效取值。
400InvalidAllocationType.ValueNotSupportedThe specified AllocationType is not supported.指定的分配类型无效。

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