Enabling or Extending the Backup Compliance Lock

Function

This API is used to enable or extend the backup compliance lock for an instance. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

Constraints

You can only enable the compliance lock or extend its retention period. You cannot disable the compliance lock.

Calling Method

For details, see Calling APIs.

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 and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
gaussdbformysql:backup:modifyVaultLock	Permission_management	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:backup:modifyVaultLock	-

URI

PUT /v3/{project_id}/instances/{instance_id}/backups/vault-lock

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. To obtain this value, see Querying DB Instances. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
backup_vaultlock_info	Yes	BackupVaultLockInfo object	Definition Backup compliance lock configurations. Constraints N/A
action	Yes	String	Definition Operation type. Constraints Only enabling and extending the compliance lock are supported. The value is case-insensitive. Range enable extend Default Value enable

**Table 4** BackupVaultLockInfo
Parameter	Mandatory	Type	Description
lock_retention_days	Yes	Integer	Definition Retention period of the compliance lock, in days. Constraints The retention period can only be configured in days. Range 1–36500 Default Value 1
lock_policy	Yes	Boolean	Definition Compliance lock policy. Constraints N/A Range Currently, this parameter can only be set to true, indicating that the compliance lock is enabled or extended. Default Value true

Response Parameters

Status code: 200

**Table 5** Response body parameter
Parameter	Type	Description
result	String	Definition Backup compliance lock enabling or extension status. Range success

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Enabling the backup compliance lock for an instance

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/vault-lock

{
  "backup_vaultlock_info" : {
    "lock_retention_days" : 7,
    "lock_policy" : true
  },
  "action" : "enable"
}

Extending the backup compliance lock for an instance

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/vault-lock

{
  "backup_vaultlock_info" : {
    "lock_retention_days" : 7,
    "lock_policy" : true
  },
  "action" : "extend"
}