Querying Backup Compliance Lock Configurations

Function

This API is used to query backup compliance lock configurations. Before calling this API:

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

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:listVaultLock	Read	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:backup:listVaultLock	-

URI

GET /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
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us: English zh-cn: Chinese Default Value en-us

Response Parameters

Status code: 200

**Table 3** Response body parameter
Parameter	Type	Description
backup_vaultlock_info	BackupVaultLockInfo object	Definition Backup compliance lock configurations. Constraints N/A

**Table 4** BackupVaultLockInfo
Parameter	Type	Description
lock_retention_days	Integer	Definition Retention period of the compliance lock, in days. Range 1–36500
lock_policy	Boolean	Definition Compliance lock policy. Range true: The compliance lock is enabled. false: The compliance lock is disabled.
lock_start_time	Integer	Definition Start time of the compliance lock, in timestamp format. Range N/A
lock_end_time	Integer	Definition End time of the compliance lock, in timestamp format. Range N/A

Status code: 400

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

Status code: 500

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

Example Request

Querying backup compliance lock configurations

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

Example Response

Status code: 200

Success.

{
  "backup_vaultlock_info" : {
    "lock_retention_days" : 7,
    "lock_start_time" : 1773042769955,
    "lock_end_time" : 1773647569000,
    "lock_policy" : true
  }
}