All Products
Search

This Product

    Cloud Backup:CreatePolicyV2

    Document Center

    Cloud Backup:CreatePolicyV2

    Last Updated:Aug 21, 2026

    Creates a policy.

    Operation description

    A backup policy records the information required for backup. After a backup policy is executed, a backup job is generated to record the backup progress and result. If the backup job succeeds, a backup snapshot is generated. You can use the backup snapshot to create a restore job.

    • A backup policy supports multiple data source types, including NAS backup, OSS backup, ECS instance backup, ECS File Backup Essential Edition, local file backup, Tablestore backup, and CPFS backup.

    • A backup policy supports only a single backup cycle policy with a fixed interval.

    • A backup policy can back up data to only one backup vault.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PolicyName

    string

    No

    The policy name.

    Daily local backup + geo-redundancy
    PolicyType

    string

    No

    The policy type. Valid values:

    • STANDARD: general backup policy. Supports backing up data sources other than ECS instances.

    • UDM_ECS_ONLY: ECS instance backup policy. Supports backing up only ECS instances.

    If you do not specify the policy type, Cloud Backup automatically sets the policy type based on whether a backup vault is specified in the policy rules:

    • A backup vault is specified in the policy rules: STANDARD

    • No backup vault is specified in the policy rules: UDM_ECS_ONLY

    STANDARD
    PolicyDescription

    string

    No

    The policy description.

    Backup once every day at 10:00 AM, with cross-region backup to Shanghai.
    Rules

    array<object>

    No

    The list of policy rules.

    array<object>

    No

    The policy rule.

    RuleType

    string

    Yes

    The rule type. Each policy must have at least one BACKUP rule and exactly one TRANSITION rule. Valid values:

    • BACKUP: backup rule.

    • TRANSITION: lifecycle rule.

    • REPLICATION: replication rule.

    • TAG: tag-based resource association rule.

    Valid values:

    • TRANSITION :

      lifecycle rule.

    • BACKUP :

      backup rule.

    • REPLICATION :

      replication rule.

    • SECURITY :

      security rule.

    • TAG :

      tag-based resource association rule.

    BACKUP
    Schedule

    string

    No

    This parameter is required only when RuleType is set to BACKUP. The backup schedule settings. Supported formats:

    • I|{startTime}|{interval}: specifies that a backup job is executed at the specified interval starting from {startTime}. For example, I|1631685600|P1D specifies that a backup job is executed once a day starting from 2021-09-15 14:00:00.

      • startTime: the start time of the backup. This value is a UNIX timestamp. Unit: seconds.

      • interval: the ISO 8601 time interval. For example, PT1H specifies an interval of one hour. P1D specifies an interval of one day.

    • C|{startTime}|{crontab}: specifies that a backup job is executed based on the {crontab} expression starting from {startTime}. For example, C|1631685600|0 0 2 ? * 3,5,7 specifies that a backup job is executed at 02:00:00 every Tuesday, Thursday, and Saturday starting from 2021-09-15 14:00:00.

      • startTime: the start time of the backup. This value is a UNIX timestamp. Unit: seconds.

      • crontab: the crontab expression. For example, 0 0 2 ? * 3,5,7 specifies every Tuesday, Thursday, and Saturday at 02:00:00.

    Backup jobs that are missed are not compensated. If the previous backup job is not complete, the next backup job is not triggered.

    I|1648647166|P1D
    BackupType

    string

    No

    This parameter is required only when RuleType is set to BACKUP. The backup type. Set the value to COMPLETE, which specifies full backup.

    Valid values:

    • ARCHIVE_BY_SEARCH :

      archive based on search results.

    • COMPLETE :

      full backup.

    • LOG :

      log backup.

    • ARCHIVE :

      archive.

    • DIFFERENTIAL :

      differential backup.

    • INDEX :

      index.

    • INCREMENTAL :

      incremental backup.

    COMPLETE
    Retention

    integer

    No

    This parameter is required only when RuleType is set to BACKUP, TRANSITION, or REPLICATION.

    • If RuleType is set to BACKUP: the retention period of backups. The priority of this parameter is lower than the Retention parameter of the rule whose RuleType is TRANSITION. Minimum value: 1. Maximum value: 364635. Unit: days.

    • If RuleType is set to TRANSITION: the retention period of backups. Minimum value: 1. Maximum value: 364635. Unit: days.

    • If RuleType is set to REPLICATION: the retention period of cross-region backups. Minimum value: 1. Maximum value: 364635. Unit: days.

    7
    ReplicationRegionId

    string

    No

    This parameter is required only when RuleType is set to REPLICATION. The ID of the destination region for replication.

    cn-shanghai
    ArchiveDays

    integer

    No

    This parameter is required only when RuleType is set to TRANSITION. The number of days after which a backup is automatically moved to the archive tier. Backups must be retained in the standard tier for at least 30 days and in the archive tier for at least 60 days. Unit: days.

    90
    RetentionRules

    array<object>

    No

    This parameter is required only when RuleType is set to TRANSITION. The special retention rules.

    object

    No

    The special retention rule.

    AdvancedRetentionType

    string

    No

    The type of the special retention rule. Valid values:

    • DAILY: daily backup.

    • WEEKLY: weekly backup.

    • MONTHLY: monthly backup.

    • YEARLY: yearly backup.

    YEARLY
    WhichSnapshot

    integer

    No

    The backup to which the rule applies. Currently, only the first backup is supported. Set the value to 1.

    1
    Retention

    integer

    No

    The special retention period of the backup. Minimum value: 1. Unit: days.

    730
    VaultId

    string

    No

    This parameter is required only when RuleType is set to BACKUP. The backup vault ID.

    v-0001************aseg
    KeepLatestSnapshots

    integer

    No

    Specifies whether to retain at least one backup version. Valid values:

    • 0: do not retain.

    • 1: retain.

    1
    Immutable

    boolean

    No

    This parameter is required only when PolicyType is set to UDM_ECS_ONLY and RuleType is set to SECURITY. Specifies whether to enable backup locking.

    true
    DataSourceFilters

    array<object>

    No

    This parameter is required only when RuleType is set to TAG. The data source filter rules.

    object

    No

    SourceType

    string

    No

    The data source type. Valid values:

    • UDM_ECS: ECS instance backup. This data source type is supported only when PolicyType is set to UDM_ECS_ONLY.

    • OSS: OSS backup. This data source type is supported only when PolicyType is set to STANDARD.

    • NAS: Alibaba Cloud NAS backup. This data source type is supported only when PolicyType is set to STANDARD.

    • ECS_FILE: ECS File Backup Essential Edition. This data source type is supported only when PolicyType is set to STANDARD.

    • OTS: Tablestore backup. This data source type is supported only when PolicyType is set to STANDARD.

    UDM_ECS
    DataSourceIds deprecated

    array

    No

    Deprecated.

    deprecated

    string

    No

    Deprecated.

    Deprecated
    TagFilters

    array<object>

    No

    This parameter is required only when RuleType is set to TAG. The resource tag filter rules.

    object

    No

    Key

    string

    No

    The tag key.

    env
    Value

    string

    No

    The tag value. An empty value indicates any value.

    prod
    Operator

    string

    No

    The tag matching rule. Valid values:

    • EQUAL: matches both the tag key and tag value.

    • NOT: matches the tag key but not the tag value.

    EQUAL

    Response elements

    Element

    Type

    Description

    Example

    object

    CreatePolicyResponse

    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true

    • false

    true
    Code

    string

    The response code. 200 indicates success.

    200
    Message

    string

    The returned message. The value "successful" is returned for a successful request. An error message is returned for a failed request.

    successful
    RequestId

    string

    The request ID.

    EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F
    PolicyId

    string

    The policy ID.

    po-000000zemnuyx2li3y9y

    Examples

    Success response

    JSON format

    {
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F",
  "PolicyId": "po-000000zemnuyx2li3y9y"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.