Creating a Policy_Policies_CBR APIs_API Reference_Cloud Backup and Recovery-Huawei Cloud

Function

This API is used to create a policy. Policies are divided into backup policies and replication policies.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v3/{project_id}/policies

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Default value: N/A For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
policy	Yes	PolicyCreate object	Body of the request for creating a policy.

**Table 4** PolicyCreate
Parameter	Mandatory	Type	Description
enabled	No	Boolean	Whether to enable the policy. The default value is true. The value can be: true: The policy is enabled, and tasks are triggered periodically. false: The policy is disabled, and tasks are not triggered periodically.
name	Yes	String	Policy name. The value consists of 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default value: N/A
operation_definition	Yes	PolicyoODCreate object	Parameter for scheduling the policy.
operation_type	Yes	String	Protection type. The value can be backup or replication. Default value: N/A
trigger	Yes	PolicyTriggerReq object	Time rule for the policy execution

**Table 5** PolicyoODCreate
Parameter	Mandatory	Type	Description
day_backups	No	Integer	Number of daily backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.
destination_project_id	No	String	Project ID of the destination region, which is mandatory for cross-region replication. Default value: N/A For details about how to obtain the project ID, see Obtaining a Project ID.
destination_region	No	String	Destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains a maximum of 255 characters, including only letters, digits, underscores (_), and hyphens (-). Default value: N/A For details about how to obtain the region ID, see Querying Regions and Endpoints.
enable_acceleration	No	Boolean	Whether to enable acceleration to shorten the cross-region replication time. If this parameter is not set, the acceleration function is disabled. If enabled, the acceleration function is additionally charged. true: The acceleration function is enabled. false: The acceleration function is disabled.
max_backups	No	Integer	Maximum number of backups that can be automatically created for a resource. The value can be -1 or in the range of 1 to 99999. Default value: N/A If the value is set to -1, backups will not be cleared when they reach the quantity limit. If this parameter and retention_duration_days are both left unspecified, backups will be retained permanently. This parameter and retention_duration_days cannot be both specified.
month_backups	No	Integer	Number of monthly backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.
retention_duration_days	No	Integer	Backup retention period, in days. The maximum value is 99999. Default value: N/A -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are both left blank, the backups will be retained permanently. This parameter cannot be applied together with max_backups, day_backups, week_backups, month_backups, or year_backups.
timezone	No	String	Time zone where the user is located, for example, UTC+08:00. Default value: N/A If any of the yearly, monthly, weekly, and daily backup parameters is selected, this parameter cannot be left blank.
week_backups	No	Integer	Number of weekly backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.
year_backups	No	Integer	Number of yearly backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.
full_backup_interval	No	Integer	Defines how often a full backup is performed. If -1 is specified, full backup will not be performed. Range: [-1, 100]; Default value: N/A

**Table 6** PolicyTriggerReq
Parameter	Mandatory	Type	Description
properties	Yes	PolicyTriggerPropertiesReq object	Policy scheduler attributes.

**Table 7** PolicyTriggerPropertiesReq
Parameter	Mandatory	Type	Description
pattern	Yes	Array of strings	Scheduling rule. A maximum of 24 rules can be configured. Scheduling rule. It complies with iCalendar RFC 2445, but it supports only parameters FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL. FREQ can be set only to WEEKLY or DAILY. BYDAY* can be set to MO, TU, WE, TH, FR, SA, or SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points can be configured in a day. For example, if the scheduling time is 14:00 (UTC time) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. For example, if the local time zone is UTC+8 and scheduling occurs daily at 14:00, the value of FREQ should reflect the equivalent UTC time, which is 14:00 minus 8 hours. The corresponding rule is: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00. Default value: N/A

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
policy	Policy object	Response to the request for creating a policy

**Table 9** Policy
Parameter	Type	Description
enabled	Boolean	Whether the policy is enabled. The value can be: true: The policy is enabled. false: The policy is disabled.
id	String	Policy ID. Range: N/A
name	String	Policy name. The value consists of 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).
operation_definition	PolicyoODCreate object	Policy attributes.
operation_type	String	Protection type. The value can be backup or replication.
trigger	PolicyTriggerResp object	Time scheduling rule for the policy
associated_vaults	Array of PolicyAssociateVault objects	Associated vault
policy_type	String	Policy type. The value can be: custom_policy: common-user policy organization_policy_v1: organizational policy of the old version organization_policy_v2: organizational policy of the new version organization_policy_removed: new organizational policy associated with a vault for a user that has left the organization. (The policy is not automatically disassociated from the vault, and cannot be associated with a new vault.)

**Table 10** PolicyoODCreate
Parameter	Type	Description
day_backups	Integer	Number of daily backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.
destination_project_id	String	Project ID of the destination region, which is mandatory for cross-region replication. Default value: N/A For details about how to obtain the project ID, see Obtaining a Project ID.
destination_region	String	Destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains a maximum of 255 characters, including only letters, digits, underscores (_), and hyphens (-). Default value: N/A For details about how to obtain the region ID, see Querying Regions and Endpoints.
enable_acceleration	Boolean	Whether to enable acceleration to shorten the cross-region replication time. If this parameter is not set, the acceleration function is disabled. If enabled, the acceleration function is additionally charged. true: The acceleration function is enabled. false: The acceleration function is disabled.
max_backups	Integer	Maximum number of backups that can be automatically created for a resource. The value can be -1 or in the range of 1 to 99999. Default value: N/A If the value is set to -1, backups will not be cleared when they reach the quantity limit. If this parameter and retention_duration_days are both left unspecified, backups will be retained permanently. This parameter and retention_duration_days cannot be both specified.
month_backups	Integer	Number of monthly backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.
retention_duration_days	Integer	Backup retention period, in days. The maximum value is 99999. Default value: N/A -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are both left blank, the backups will be retained permanently. This parameter cannot be applied together with max_backups, day_backups, week_backups, month_backups, or year_backups.
timezone	String	Time zone where the user is located, for example, UTC+08:00. Default value: N/A If any of the yearly, monthly, weekly, and daily backup parameters is selected, this parameter cannot be left blank.
week_backups	Integer	Number of weekly backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.
year_backups	Integer	Number of yearly backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.
full_backup_interval	Integer	Defines how often a full backup is performed. If -1 is specified, full backup will not be performed. Range: [-1, 100]; Default value: N/A

**Table 11** PolicyTriggerResp
Parameter	Type	Description
id	String	Scheduler ID. Range: N/A
name	String	Scheduler name. Range: N/A
properties	PolicyTriggerPropertiesResp object	Policy scheduler attributes.
type	String	Scheduler type. Currently, only time (periodic scheduling) is supported.

**Table 12** PolicyTriggerPropertiesResp
Parameter	Type	Description
pattern	Array of strings	Scheduling rule. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL. FREQ can be set only to WEEKLY or DAILY. BYDAY* can be set to MO, TU, WE, TH, FR, SA, or SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC time) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. For example, if the time of an area is UTC+8. The scheduling is performed at 14:00 every day in this area. The value of FREQ is the same as that of 14:00 minus 8. The rule is as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00.
start_time	String	Scheduler start time, for example, 2020-01-08 09:59:49.

**Table 13** PolicyAssociateVault
Parameter	Type	Description
destination_vault_id	String	ID of the associated remote vault. For details, see Obtaining a Vault ID, where project_id must be set to the project ID of the destination region.
vault_id	String	Vault ID. For details about how to obtain the vault ID, see Obtaining a Vault ID.

Example Requests

Creating a backup policy with backups automatically executed at 14:00 everyday and with each backup saved for one day

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies

{
  "policy" : {
    "enabled" : true,
    "name" : "policy001",
    "operation_definition" : {
      "day_backups" : 0,
      "month_backups" : 0,
      "retention_duration_days" : 1,
      "timezone" : "UTC+08:00",
      "week_backups" : 0,
      "year_backups" : 0
    },
    "operation_type" : "backup",
    "trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ]
      }
    }
  }
}

Creating a replication policy with backups automatically replicated at 14:00 everyday and with each backup saved for one day

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies

{
  "policy" : {
    "enabled" : true,
    "name" : "policy002",
    "operation_definition" : {
      "retention_duration_days" : 1,
      "day_backups" : 0,
      "week_backups" : 0,
      "month_backups" : 0,
      "year_backups" : 0,
      "timezone" : "UTC+08:00",
      "destination_region" : "cn-southwest-247",
      "destination_project_id" : "fcf6cb26c3bf4402869792207ad3dce4"
    },
    "operation_type" : "replication",
    "trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ]
      }
    }
  }
}

Example Responses

Status code: 200

OK

The backup policy is created. The replication policy is to automatically replicate backups at 14:00 everyday and save each backup for one day.

{
  "policy" : {
    "name" : "policy001",
    "enabled" : true,
    "trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
        "start_time" : "2019-05-08T06:57:05.000+00:00"
      },
      "type" : "time",
      "id" : "d67269a6-5369-42d7-8150-5254bd446328",
      "name" : "default"
    },
    "operation_definition" : {
      "retention_duration_days" : 1,
      "year_backups" : 0,
      "day_backups" : 0,
      "month_backups" : 0,
      "week_backups" : 0,
      "timezone" : "UTC+08:00"
    },
    "operation_type" : "backup",
    "id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff",
    "policy_type" : "custom_policy"
  }
}

The replication policy is created. The replication policy is to automatically replicate backups at 14:00 everyday and save each backup for one day.

{
  "policy" : {
    "name" : "policy002",
    "enabled" : true,
    "trigger" : {
      "id" : "b37cf79e-5cfa-4a84-99a3-91d60a314c46",
      "name" : "default",
      "type" : "time",
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
        "start_time" : "2019-05-08T06:58:05.000+00:00"
      }
    },
    "operation_definition" : {
      "retention_duration_days" : 1,
      "day_backups" : 0,
      "week_backups" : 0,
      "month_backups" : 0,
      "year_backups" : 0,
      "timezone" : "UTC+08:00",
      "destination_region" : "cn-southwest-247",
      "destination_project_id" : "fcf6cb26c3bf4402869792207ad3dce4"
    },
    "operation_type" : "replication",
    "id" : "e47e4916-481a-4d10-95a2-165bcfe598c5",
    "policy_type" : "custom_policy"
  }
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Creating a Policy