更新时间:2024-09-11 GMT+08:00

打开或关闭备份加密

功能介绍

打开或关闭备份加密。

URI

POST /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
表3 请求Body参数

参数

是否必选

参数类型

描述

encryption_status

String

开启或关闭加密。不区分大小写。

取值范围:

  • on:开启。
  • off:关闭。

type

String

加密类型。当前只支持kms。 开启加密时必传,关闭加密时不传。 不区分大小写。

kms_key_id

String

kms加密ID。加密时必传,关闭加密时候不传。

通过调用数据加密服务的创建密钥接口获取(响应参数的key_id即为加密ID)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

encryption_status

String

备份加密状态。

取值范围:

  • on:开启状态。
  • off:关闭状态。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 开启备份加密
    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption
    {
      "type" : "kms",
      "kms_key_id" : "b82fa43f-f6e8-4ec4-9c31-231bc547c526",
      "encryption_status" : "on"
    }
  • 关闭备份加密
    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption
    {
      "encryption_status" : "off"
    }

响应示例

状态码: 200

Success.

{
  "encryption_status" : "on"
}

状态码

请参见状态码

错误码

请参见错误码