Queries the Object Storage Service (OSS) storage plans that you have purchased in an Alibaba Cloud region. OSS storage plans can be used to offset bills for the storage capacity of normal snapshots instead of local snapshots.

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 DescribeSnapshotPackage

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

PageNumber Integer No 1

The number of the page to return. Pages start from page 1.

Default value: 1.
PageSize Integer No 10

The number of entries to return on each page. Maximum value: 100.

Default value: 10.
RegionId String Yes cn-hangzhou

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

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 the OSS storage plans.

SnapshotPackages Array of SnapshotPackage

Details about the OSS storage plans.

SnapshotPackage
DisplayName String testDisplayName

The name of the OSS storage plan.

EndTime String 2018-11-30T06:32:31Z

The time when the OSS storage plan expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

StartTime String 2017-11-30T06:32:31Z

The time when the OSS storage plan was purchased. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

InitCapacity Long 500

The maximum storage capacity offered by the OSS storage plan.

Examples

Sample requests

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

Sample success responses

XML format

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

<DescribeSnapshotPackageResponse>
	<TotalCount>1</TotalCount>
	<PageNumber>1</PageNumber>
	<PageSize>5</PageSize>
	<SnapshotPackages>
		<SnapshotPackage>
			<StartTime>2017-11-30T06:32:31Z</StartTime>
			<EndTime>2018-11-30T06:32:31Z</EndTime>
			<InitCapacity>500</InitCapacity>
			<DisplayName>sp-snapshotpackage1</DisplayName>
		</SnapshotPackage>
	</SnapshotPackages>
	<RequestId>ACD9BBB0-A9D1-46D7-9630-B7A69889E110</RequestId>
</DescribeSnapshotPackageResponse>

JSON format

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

{
  "TotalCount" : "1",
  "PageNumber" : "1",
  "PageSize" : "5",
  "SnapshotPackages" : {
    "SnapshotPackage" : [ {
      "StartTime" : "2017-11-30T06:32:31Z",
      "EndTime" : "2018-11-30T06:32:31Z",
      "InitCapacity" : "500",
      "DisplayName" : "sp-snapshotpackage1"
    } ]
  },
  "RequestId" : "ACD9BBB0-A9D1-46D7-9630-B7A69889E110"
}

Error codes

For a list of error codes, see Service error codes.