Queries the details about one or more storage capacity units (SCUs).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeStorageCapacityUnits

The operation that you want to perform. Set the value to DescribeStorageCapacityUnits.

RegionId String Yes cn-hangzhou

The region ID of the SCU. You can call the DescribeRegions operation to query the most recent region list.

PageNumber Integer No 1

The number of the page to return.

Pages start from page 1.

Default value: 1

PageSize Integer No 1

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

Name String No testScuName

The name of the SCU.

Capacity Integer No 20

The capacity of the SCU. Unit: GiB. Valid values: 20, 40, 100, 200, 500, 1024, 2048, 5120, 10240, 20480, and 51200.

AllocationType String No Normal

The allocation type. Valid values:

  • Normal: queries SCUs within the current Alibaba Cloud account.
  • Shared: queries SCUs shared between the Alibaba Cloud account and RAM users.

Default value: Normal.

StorageCapacityUnitId.N String No scu-bp67acfmxazb4p****

The ID of SCU N. Valid values of N: 1 to 100.

Status.N String No Active

The state of SCU N. Valid values of N: 1 to 4. Valid values:

  • Creating: The SCU is being created.
  • Active: The SCU is enabled.
  • Expired: The SCU has expired.
  • Pending: The SCU is pending.
Tag.N.Key String No TestKey

The key of tag N of the SCU. N indicates that you can set multiple tag keys to query. Valid values of N: 1 to 20.

Tag.N.Value String No TestValue

The value of tag N of the SCU. N indicates that you can set multiple tag values to query and corresponds to N of Tag.N.Key. Valid values of N: 1 to 20.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

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

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The total number of SCUs.

StorageCapacityUnits Array of StorageCapacityUnit

Details about the SCUs.

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

The time when the SCU was created.

Status String Active

The state of the SCU.

StartTime String 2021-08-17T02:55Z

The time when the SCU took effect.

Capacity Integer 20

The capacity of the SCU.

Description String testScuDescription

The description of the SCU.

AllocationStatus String allocated

Indicates the allocation state of the SCU when the AllocationType parameter is set to Shared. Valid values:

  • allocated: The SCU is allocated to other accounts.
  • BeAllocated: The SCU is allocated from another account.
ExpiredTime String 2021-09-17T16:00Z

The time when the SCU expires.

StorageCapacityUnitId String scu-bp67acfmxazb4p****

The ID of the SCU.

Name String testScuName

The name of the SCU.

RegionId String cn-hangzhou

The region ID of the SCU.

Tags Array of Tag

The tag key-value pairs of the SCU.

Tag
TagValue String TestKey

The tag key of the SCU.

TagKey String TestValue

The tag value of the SCU.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeStorageCapacityUnits
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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 format

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"
    } ]
  }
}

Errors codes

HTTP status code Error code Error message Description
400 MissingParameter.RegionId The specified RegionId should not be null. The error message returned because the required RegionId parameter is not specified.
400 InvalidParameter.Name The specified Name is invalid. The error message returned because the specified Name parameter is invalid.
400 InvalidParameter.CapacityExceed The specified Capacity exceeds the limitation of quota. The error message returned because the specified Capacity parameter exceeds the upper limit.
400 InvalidAllocationType.ValueNotSupported The specified AllocationType is not supported. The error message returned because the specified AllocationType parameter is invalid.

For a list of error codes, visit the API Error Center.