ExportSnapshot - Elastic Compute Service - Alibaba Cloud Documentation Center

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

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:ExportSnapshot

create

*Snapshot

acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}

None

Request parameters

Parameter	Type	Required	Description	Example
SnapshotId	string	Yes	The ID of the snapshot to export.
RegionId	string	Yes	The ID of the region where the snapshot is located. You can call the `DescribeRegions` operation to query the latest region list.
OssBucket	string	Yes	The name of the destination OSS bucket. The bucket must be in the same region as the snapshot.
RoleName	string	No	The name of the RAM role that authorizes ECS to export the snapshot. This role must grant ECS permission to write to the specified OSS bucket. If you omit this parameter, ECS uses its default service-linked role.

Response elements

Element	Type	Description	Example
	object	The response object.
TaskId	string	The export task ID. Call the `DescribeTasks` operation to check the task status.
RequestId	string	The request ID.

Examples

Success response

JSON format

{
  "TaskId": "",
  "RequestId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
403	ExportSnapshotFailed	Exporting snapshot is failed, Please contact the administrator.
403	SNAPSHOT_IS_EXPORTING	The specified snapshot is already exporting.
403	InvalidSnapshotId.NotFound	The specified snapshot is not exists.	The specified source snapshot does not exist.
403	SNAPSHOT_CREATE_NOT_FINISHED	The specified snapshot is not finished yet.
403	OSS_AUTHORIZED_FAILED	ECS service account Have no right to access your OSS. please attach a role of access your oss to ECS service account.
403	InvalidOSSBucket.NotFound	The specified OSS bucket does not exist in this region.
403	InvalidUser.NotInWhiteList	The user is not in the white list of exporting snapshot.
403	InvalidOSSBucket.InOtherRegion	The specified OSS bucket is in another region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.