Replicate ENS Snapshots Across Nodes with CopySnapshot API - ENS - Alibaba Cloud - ENS

Calls CopySnapshot to copy a snapshot across edge zones.

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

ens:CopySnapshot

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SnapshotId	string	Yes	The ID of the source snapshot.	sp-bp1c0doj0taqyzzl****
DestinationRegionIds	array	Yes	The list of destination edge zone IDs.
	string	Yes	The destination edge zone ID.	cn-hangzhou-26,cn-hangzhou-27
DestinationSnapshotName	string	No	The display name of the snapshot. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. It can contain digits, colons (:), underscores (_), or hyphens (-).	testSnapshotName
DestinationSnapshotDescription	string	No	The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.	testDescription
InstanceBillingCycle	string	No	The billing cycle of the instance. Valid values: Hour Day Month Valid values: Month : month. Hour : hour. Day : day.	Hour

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	EA3758E0-8899-17D3-9526-5F62CF33A586
AllocationId	array<object>	The list of successfully created snapshots.
	object
EnsRegionId	string	The ID of the edge zone where the snapshot resides.	cn-hangzhou-27
InstanceId	array	The array of instance IDs.
	string	The array of instance IDs.	e426409223
BizStatusCode	string	The status code indicating success. Valid values: PartSuccess: Partially successful. AllSuccess: All successful.	PartSuccess
UnAllocationId	array<object>	The list of edge zones where snapshot creation failed.
	object
EnsRegionId	string	The ID of the edge zone where the snapshot resides.	cn-chengdu-26

Examples

Success response

JSON format

{
  "RequestId": "EA3758E0-8899-17D3-9526-5F62CF33A586",
  "AllocationId": [
    {
      "EnsRegionId": "cn-hangzhou-27",
      "InstanceId": [
        "e426409223"
      ]
    }
  ],
  "BizStatusCode": "PartSuccess",
  "UnAllocationId": [
    {
      "EnsRegionId": "cn-chengdu-26"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	SaleControl.VerificationFailed	You did not pass the salecontrol verification.Please contact the product.	Failed to pass the sales constraint verification when you create the resource.
400	Invalid%s	The specified parameter %s is invalid.
400	ENS_SERVICE_ARREARAGE	用户欠费
400	Order.CreateFailed	Failed to create order. Please check your parameters and try it again.	Failed to create the order.
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.