You can call this operation to query the Object Storage Service (OSS) storage plans that you have purchased in an Alibaba Cloud region. OSS storage plans can be used to offset the storage space of 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
RegionId String Yes cn-hangzhou

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

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.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

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

The ID of the request.

SnapshotPackages

An array consisting of SnapshotPackage data.

DisplayName String FinanceJoshua

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.

InitCapacity Long 500

The storage space offered by the OSS storage plan.

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.

TotalCount Integer 1

The total number of returned OSS storage plans.

Examples

Sample requests

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

Sample success responses

XML format

<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

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

Error codes

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