查询备份合规锁配置 - ShowBackupVaultLock

功能介绍

查询备份合规锁配置。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的project ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID，此参数是实例的唯一标识。获取方法请参见查询实例列表。约束限制：不涉及。取值范围：只能由英文字母、数字组成，后缀为in07，长度为36个字符。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
X-Language	否	String	参数解释：请求语言类型。约束限制：不涉及。取值范围： en-us zh-cn 默认取值： en-us。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
backup_vaultlock_info	BackupVaultLockInfo object	参数解释：备份合规锁配置。约束限制：不涉及。

表4 BackupVaultLockInfo
参数	参数类型	描述
lock_retention_days	Integer	参数解释：合规锁保留期，单位是天。取值范围： 1-36500。
lock_policy	Boolean	参数解释：合规锁配置策略。取值范围： true：已开启合规锁配置。 false: 未开启合规锁配置。
lock_start_time	Integer	参数解释：合规锁开始时间，时间戳格式。取值范围：不涉及。
lock_end_time	Integer	参数解释：合规锁结束时间，时间戳格式。取值范围：不涉及。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

状态码：500

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

查询备份合规锁配置。

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

响应示例

状态码：200

Success.

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