Modifying the Backup Policy Bound to Vault

Function

This API is used to modify the backup policy associated with the vault.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

PUT /v5/{project_id}/backup/policy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
enabled	No	Boolean	Definition Whether the policy is enabled. Constraints N/A Range true: The policy is enabled. false: The policy is disabled. Default Value true
policy_id	Yes	String	Definition Policy ID. This parameter is mandatory if backup protection is enabled. You can obtain the ID by calling the API for Querying Information About the Backup Policy Bound to an HSS Vault. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
operation_definition	No	OperationDefinitionRequestInfo object	Definition Scheduling parameter. Constraints N/A Range The value range is 0 to 100. Default Value N/A
trigger	No	BackupTriggerRequestInfo object	Time scheduling rule for the policy

**Table 5** OperationDefinitionRequestInfo
Parameter	Mandatory	Type	Description
day_backups	No	Integer	Definition Number of daily backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Constraints N/A Range The value range is 0 to 100. Default Value N/A
max_backups	No	Integer	Definition Maximum number of backups that can be automatically created for an object. 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 blank, the backups will be retained permanently. Constraints N/A Range The value can be -1 or in the range 1 to 99,999. Default Value -1
month_backups	No	Integer	Definition Number of monthly backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Constraints N/A Range The value range is 0 to 100. Default Value N/A
retention_duration_days	No	Integer	Definition Backup retention period, in days. The maximum value is 99,999. If the value is set to -1, backups will not be cleared by retention duration. If this parameter and max_backups are both left blank, the backups will be retained permanently. Constraints N/A Range Value range: -1 to 99,999 Default Value -1
timezone	No	String	Definition Time zone where the user is located, for example, UTC+08:00 Constraints This parameter cannot be set if none of the yearly, monthly, weekly, and daily backup parameters is selected. Range UTC+05:00 UTC+06:00 UTC+07:00 ... Default Value N/A
week_backups	No	Integer	Definition Number of weekly backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Constraints N/A Range The value range is 0 to 100. Default Value N/A
year_backups	No	Integer	Definition Number of yearly backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Constraints N/A Range The value range is 0 to 100. Default Value N/A

**Table 6** BackupTriggerRequestInfo
Parameter	Mandatory	Type	Description
properties	Yes	BackupTriggerPropertiesRequestInfo object	Time rule for the policy execution.

**Table 7** BackupTriggerPropertiesRequestInfo
Parameter	Mandatory	Type	Description
pattern	Yes	Array of strings	Definition Scheduling rule. This parameter is mandatory if the backup function is enabled with ransomware protection. Constraints A maximum of 24 rules can be configured. Range 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 from Monday to Sunday, set the scheduling rule as follows: 'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00' To start scheduling at 14:00 every day, the rule is as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00' Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Modify the backup policy. The target backup policy ID is af4d08ad-2b60-4916-a5cf-8d6a23956dda.

PUT https://{endpoint}/v5/{project_id}/backup/policy

{
  "enabled" : true,
  "policy_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
  "operation_definition" : {
    "day_backups" : 0,
    "max_backups" : -1,
    "month_backups" : 0,
    "retention_duration_days" : 5,
    "timezone" : "UTC+08:00",
    "week_backups" : 0,
    "year_backups" : 0
  },
  "trigger" : {
    "properties" : {
      "pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ]
    }
  }
}