All Products
Search

This Product

    Elastic Compute Service:CreateEnterpriseSnapshotPolicy

    Document Center

    Elastic Compute Service:CreateEnterpriseSnapshotPolicy

    Last Updated:Sep 25, 2024

    Creates an enterprise-level snapshot policy.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ebs:CreateEnterpriseSnapshotPolicy
    • EnterpriseSnapshotPolicy
      acs:ebs:{#regionId}:{#accountId}:enterprisesnapshotpolicy/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID . You can call the DescribeRegions operation to query the most recent list of regions in which snapshot policy is supported.

    		cn-hangzhou
    NamestringYes

    The name of the policy.

    		xx
    TargetTypestringYes

    Binding target type, valid value:

    • DISK
    		DISK
    StatestringNo

    The status of the policy. Valid values:

    • ENABLED: Enable snapshot policy execution.

    • DISABLED: Disable snapshot policy execution.

    		ENABLED
    DescstringNo

    The description of the policy.

    		xxx
    ScheduleobjectYes

    The rule for scheduling.

    CronExpressionstringYes

    The time when the policy will to be scheduled. Valid values: Set the parameter in a cron expression.

    For example, you can use 0 0 4 1/1 * ? to specify 04:00:00 (UTC+8) on the first day of each month.

    		0 0 */24 * * *
    RetainRuleobjectYes

    The snapshot retention rule.

    NumberintegerNo

    Maximum number of retained snapshots.

    		10
    TimeIntervalintegerNo

    The time interval , valid value greater than 1.

    		14
    TimeUnitstringNo

    The unit of time, valid values:

    • DAYS

    • WEEKS

    		DAYS
    StorageRuleobjectNo

    Advanced snapshot features.

    EnableImmediateAccessbooleanNo

    Whether to enable the rapid availability of snapshots. The range of values:

    • true

    • false

    		false
    CrossRegionCopyInfoobjectNo

    Snapshot replication destination information.

    EnabledbooleanNo

    Whether cross-region replication is enabled. The range of values:

    • true

    • false

    		false
    Regionsarray<object>No

    The list of destination regions.

    RegionobjectNo

    Destination region.

    RegionIdstringNo

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

    		cn-hangzhou
    RetainDaysintegerNo

    Number of days to retain the destination snapshot. The range of values is greater than 1.

    		7
    Tagarray<object>No

    The list of tags.

    TagobjectNo

    The tag.

    KeystringYes

    The key of the tag.

    		tag-key
    ValuestringYes

    The tag value.

    The tag value can be 0 to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://.

    Each tag key must have a unique tag value. You can specify at most 20 tag values in each call.

    		tag-value
    ResourceGroupIdstringNo

    The ID of the resource group to which to assign the snapshot policy.

    		xxx
    ClientTokenstringNo

    The client token that is used to ensure the idempotency of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

    		123e4567-e89b-12d3-a456-42665544****
    SpecialRetainRulesobjectNo

    The special snapshot retention rules.

    EnabledbooleanNo

    Indicates whether the special retention is enabled.

    • true: enable
    • false: disable
    		true
    Rulesarray<object>No

    The special retention rules.

    RuleobjectNo

    The special retention rule.

    SpecialPeriodUnitstringNo

    The periodic unit for specially retained snapshots. If configured to WEEKS, it provides special retention for the first snapshot of each week. The retention period is determined by TimeUnit and TimeInterval. The range of values are:

    • WEEKS
    • MONTHS
    • YEARS
    		WEEKS
    TimeIntervalintegerNo

    Retention Time Value. The range of values is greater than 1.

    		14
    TimeUnitstringNo

    Retention time unit for special snapshots. The range of values:

    • DAYS

    • WEEKS

    		WEEKS

    Response parameters

    ParameterTypeDescriptionExample
    object

    Response

    PolicyIdstring

    The id of a policy.

    		esp-xxx
    RequestIdstring

    The request ID.

    		7A8959DA-1E04-5724-8288-58334031454E

    Examples

    Sample success responses

    JSONformat

    {
  "PolicyId": "esp-xxx",
  "RequestId": "7A8959DA-1E04-5724-8288-58334031454E"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameterThe parameter %s is invalid.The specified parameter value is invalid.
    400InvalidParameter.ConflictThe specified parameter %s and %s are not blank at the same time.-
    400InvalidParameter.FormatSpecified parameter format is not valid.english description
    400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.The parameter must be specified.
    403ForbiddenUser is not authorized to operate.You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
    403Forbidden.ActionUser 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.
    403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.-
    403LastTokenProcessingThe last token request is processing.The value of clientToken is used in another request that is being processed. Try again later.
    403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.You are not authorized to create service-linked roles.
    403OperationDeniedThe operation is not allowed.The operation is not supported.
    404InvalidApi.NotFoundSpecified api is not found, please check your url and method.-
    404NoSuchResourceThe specified resource does not exist.The specified resource does not exist.
    500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred.
    504RequestTimeoutThe request is timeout, please try again later.The request has timed out. Try again later.

    For a list of error codes, visit the Service error codes.