You can call the DescribeStoragePackages operation to query the list of storage plans.


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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeStoragePackages

The operation that you want to perform.

Set the value to DescribeStoragePackages.

RegionId String Yes cn-hangzhou

The region ID.

PageSize Integer No 10

The number of storage plans to return on each page.

Valid values: 1 to 100.

Default value: 10.

UseUTCDateTime Boolean No true

Specifies whether the time to return is in UTC.

Valid values:

  • true (default): returns UTC time.
  • false: returns UNIX timestamp.
PageNumber Integer No 1

The number of the page to return.

Pages start from page 1. Default value: 1.

Response parameters

Parameter Type Example Description
Packages Array of Package

The list of storage plans.

ExpiredTime String 2020-01-05T16:00:00Z

The end time of the validity period for the storage plan.

FileSystemId String 109c****66

The ID of the file system that is bound to the storage plan.

PackageId String naspackage-@string('*****', *)-@string('*****', *)

The ID of the storage plan.

Size Long 10

The capacity of the storage plan.

Unit: bytes.

StartTime String 2019-12-05T01:40:56Z

The start time of the validity period for the storage plan.

Status String free

The status of the storage plan.

Valid values:

  • free: The storage plan is not bound to a file system. You can bind the storage plan to a file system of the same storage type.
  • bound: The storage plan is bound to a file system.
StorageType String Capacity

The type of the storage plan.

Valid values:

  • Performance
  • Capacity
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 1

The number of storage plans returned per page.

RequestId String 035B3A3A-E514-4B41-B906-5D906CFB****

The ID of the request.

TotalCount Integer 3

The number of storage plans.


Sample requests

http(s)://[Endpoint]/? Action=DescribeStoragePackages
&<Common request parameters>

Sample success responses

XML format

        <PackageId>naspackage-@string('*****', *)-@string('*****', *)</PackageId>

JSON format

    "TotalCount": 3,
    "PageSize": 1,
    "RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
    "PageNumber": 1,
    "Packages": {
        "Package": {
            "Status": "free",
            "StorageType": "Capacity",
            "Size": 10,
            "ExpiredTime": "2020-01-05T16:00:00Z",
            "StartTime": "2019-12-05T01:40:56Z",
            "FileSystemId": "109c****66",
            "PackageId": "naspackage-@string('*****', *)-@string('*****', *)"

Error codes

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