DescribeSnapshotPackage-阿里云帮助中心

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeSnapshotPackage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1	1
PageSize	integer	No	The number of entries per page. Maximum value: 1 to 100. Default value: 10	10
RegionId	string	Yes	The ID of the request.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of OSS storage plans.	1
SnapshotPackages	object
SnapshotPackage	array<object>	Details about the OSS storage plans.
	object
DisplayName	string	The name of the OSS storage plan.	testDisplayName
EndTime	string	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.	2018-11-30T06:32:31Z
StartTime	string	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.	2017-11-30T06:32:31Z
InitCapacity	integer	The maximum storage capacity offered by the OSS storage plan.	500

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "SnapshotPackages": {
    "SnapshotPackage": [
      {
        "DisplayName": "testDisplayName",
        "EndTime": "2018-11-30T06:32:31Z",
        "StartTime": "2017-11-30T06:32:31Z",
        "InitCapacity": 500
      }
    ]
  }
}

Error response

JSON format

{
	"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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.