CreateEnterpriseSnapshotPolicy - - Alibaba Cloud Documentation Center

Creates an enterprise-level snapshot policy by calling CreateEnterpriseSnapshotPolicy.

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

ebs:CreateEnterpriseSnapshotPolicy

create

*EnterpriseSnapshotPolicy

acs:ebs:{#regionId}:{#accountId}:enterprisesnapshotpolicy/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the regions that support asynchronous replication.	cn-hangzhou
Name	string	Yes	The Policy Name.	xx
TargetType	string	Yes	The type. Valid values: DISK Valid values: DISK : DISK	DISK
State	string	No	The status. Valid values: DISABLED ENABLED Valid values: DISABLED : DISABLED ENABLED : ENABLED	ENABLED
Desc	string	No	The description.	xxx
Schedule	object	Yes	The schedule rule.
CronExpression	string	Yes	The cycle and time at which the policy is executed. Specify the value in a cron expression. For example, `0 0 4 1/1 * ?` specifies that the snapshot operation is performed at 4:00 AM every day, starting from the first day of each month.	0 0 /24 * *
RetainRule	object	Yes	The retention rule.
Number	integer	No	The number of snapshots to retain. Valid values: 1 to 256.	10
TimeInterval	integer	No	The time interval of the retention rule. The unit is specified by the TimeUnit parameter. The value must be greater than 1.	14
TimeUnit	string	No	The unit of the retention time. Valid values: DAYS WEEKS Valid values: WEEKS : WEEKS DAYS : DAYS	DAYS
StorageRule	object	No	The advanced snapshot feature.
EnableImmediateAccess	boolean	No	Specifies whether to enable instant access for snapshots. Valid values: true false Valid values: true : true false : false	false
CrossRegionCopyInfo	object	No	The snapshot replication information.
Enabled	boolean	No	Specifies whether to enable cross-region replication. Valid values: true false Valid values: true : true false : false	false
Regions	array<object>	No	The destination region information.
	object	No	The replication destination region information. This parameter is optional.
RegionId	string	No	The ID of the destination region for snapshot replication. You can invoke DescribeDiskReplicaPairs to query the region information of existing asynchronous replication relationships.	cn-hangzhou
RetainDays	integer	No	The number of days to retain snapshots in the destination region. The value must be greater than 1.	7
Tag	array<object>	No	The tag key-value pairs. Valid values of n: 1 to 20.
	object	No	The tag.
Key	string	Yes	The tag key of the resource.	tag-key
Value	string	Yes	The tag value of the resource.	tag-value
ResourceGroupId	string	No	The resource group ID.	xxx
ClientToken	string	No	Ensures the idempotence of the request. Generate a parameter value from your client that is unique across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-42665544****
SpecialRetainRules	object	No	The special retention rules.
Enabled	boolean	No	Specifies whether to enable special retention. Valid values: true false Valid values: true : true false : false	true
Rules	array<object>	No	The list of special retention rules.
	object	No	The special retention rules.
SpecialPeriodUnit	string	No	The period unit for specially retained snapshots. For example, if this parameter is set to WEEKS, the first snapshot of each week is specially retained. The retention duration is determined by TimeUnit and TimeInterval. Valid values: WEEKS MONTHS YEARS Valid values: MONTHS : MONTHS YEARS : YEARS WEEKS : WEEKS	WEEKS
TimeInterval	integer	No	The time interval of the retention rule. The unit is specified by the TimeUnit parameter. The value must be greater than 1.	14
TimeUnit	string	No	The unit of the retention time for special snapshots. Valid values: DAYS WEEKS Valid values: WEEKS : WEEKS DAYS : DAYS	WEEKS

Response elements

Element	Type	Description	Example
	object	The response.
PolicyId	string	The snapshot policy ID.	esp-xxx
RequestId	string	The request ID.	F13483A9-17E2-5085-9B2E-2155B0487FF7

Examples

Success response

JSON format

{
  "PolicyId": "esp-xxx",
  "RequestId": "F13483A9-17E2-5085-9B2E-2155B0487FF7"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter %s is invalid.	The specified parameter value is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.	english description
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	The parameter must be specified.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.	The value of clientToken is used in another request that is being processed. Try again later.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	You are not authorized to create service-linked roles.
403	OperationDenied	The operation is not allowed.	The operation is not supported.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.