Docs

Elastic Compute Service

Reserved storage capacity

DescribeReservedStorageCapacity - Query reserved storage capacity package

Call the DescribeReservedStorageCapacity API to query reserved storage capacity package information.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following lists only the request parameters unique to this API and some common parameters. For more information, see common parameters.

Action string required Example: DescribeReservedStorageCapacity

The operation to perform, value: DescribeReservedStorageCapacity.

Version string required Example: 2020-04-01

The API version, value: 2020-04-01.

ProjectName string optional Example: default

Name of the project to which RSC belongs.

ReservedStorageCapacityName string optional Example: cn-beijing-a

The name of the reserved storage capacity package.

ZoneId string Optional Example: cn-beijing-a

Available zone where the reserved storage capacity package is located.

tip

The region where the reserved storage capacity package is located defaults to the requested Region, which is the Region in the Header.

VolumeType string Optional Example value: ESSD_PL0

Reserved storage capacity package reserved cloud disk specifications are explained as follows:

ESSD_PL0: ultra-fast SSD cloud disk, PL0 specification

ESSD_FlexPL: ultra-fast SSD cloud disk, FlexPL specification

Status string optional example value: available

Status of reserved storage capacity packages, with the following values:

creating: creating

available: active

terminated: inactive

PageNumber string Optional Example: 1

Page number to query.

PageSize string optional example value: 100

Sets the number of rows per page for paginated queries.

ReservedStorageCapacityIds.N string[] required Example: rsc-3vpnts78dk3x35cj****

reserved storage capacity package ID.

Response parameters

The following lists only the response parameters unique to this API. For more information, see response structure.

PageSize integer Example: 100

Number of rows per page.

PageNumber integer Example: 1

The current page number.

TotalCount integer example value: 5

The number of reserved storage capacity packages.

RscInfo object[] Example: -

Reserved storage package information.

Id string Example: rsc-3vpnts78dk3x35cj****

Reserved storage capacity package ID.

Name string example: rsc01

name of the reserved storage capacity package.

ZoneId string example value: cn-beijing-a

The availability zone of the reserved storage package.

Type string Example: ESSD_PL0

The reserved storage capacity package specifies the cloud disk type, with the following value descriptions:

ESSD_PL0: extreme performance SSD cloud disk, PL0 specification

ESSD_FlexPL: extreme performance SSD cloud disk, FlexPL specification

AccountId string Example value: 21000****

Account ID for the reserved storage capacity package.

Status string Example: available

The status of the reserved storage capacity package, with the following values:

creating: Creating

available: active

terminated: inactive

TakeEffectTime string example value: 2024-06-24T14:00:00+08:00

The effective time of the reserved storage capacity package.

ExpiredTime string Example value: 2024-07-24T23:59:59+08:00

Expiration time of the reserved storage capacity package.

Size long example: 600

capacity of the reserved storage capacity package.

RemainingSize integer example: 50

unused proportion of the reserved storage capacity package, calculated as used duration divided by total purchased duration.

CreatedAt string Example: 2026-07-13T10:02:57+08:00

Creation time of the reserved block storage package.

ProjectName string example: default

RSC project name.

Sample request

GET /?Action=DescribeReservedStorageCapacity&Version=2020-04-01 HTTP/1.1​
Host: open.volcengineapi.com​
Region: cn-beijing​
ServiceName: storage_ebs​

Return example

{​
    "ResponseMetadata": {​
        "RequestId": "ca07101e-d33a-4e38-8240-cfcf10dc****",​
        "Action": "DescribeReservedStorageCapacity",​
        "Version": "2020-04-01",​
        "Service": "EBS",​
        "Region": "cn-tianjin-5"​
    },​
    "Result": {​
        "PageNumber": 1,​
        "PageSize": 15,​
        "RscInfo": [​
            {​
                "AccountId": "21000****",​
                "ExpiredTime": "2024-08-04T23:59:59+08:00",​
                "Id": "rsc-3vpnts78dk3x35cj****",​
                "LoseEffectTime": "",​
                "Name": "zgl-test",​
                "RemainingSize": 100,​
                "Size": 40,​
                "Status": "available",​
                "TakeEffectTime": "2024-07-04T16:00:00+08:00",​
                "Type": "ESSD_PL0",​
                "ZoneId": "cn-chengdu-a"​
            }​
        ],​
        "TotalCount": 1​
    }​
}​

Error codes

The following table lists the error codes related to this interface and business logic. Refer to the Public Error Codes document for common error codes.

Status Code	Error codes	Error message	Description
400	InvalidRequest	The operation is not permitted due to the request is invalid.	invalid request.
404	InstanceNotFound	The specified instance does not exist.	The instance does not exist.

Last updated: 2026.07.13 18:18:38