文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API(推荐)/ 备份管理/ 查询实例是否开启备份加密功能
更新时间:2024-02-27 GMT+08:00

查询实例是否开启备份加密功能

功能介绍

查询实例是否开启备份加密功能。

URI

GET /v3/{project_id}/instances/{instance_id}/backups/encryption

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

instance_id

String

实例ID,严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us
  • zh-cn

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

encryption_status

String

备份加密状态。

取值范围:

  • on:开启备份加密。
  • off:关闭备份加密。

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询实例是否开启备份加密。

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption

响应示例

状态码: 200

Success.

{
  "encryption_status" : "on"
}

状态码

请参见状态码

错误码

请参见错误码