打开或关闭备份加密
接口约束
该接口目前公测阶段，如需使用，请提交工单联系客服人员申请权限。
URI
POST /v3/{project_id}/instances/{instance_id}/backups/encryption
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
|
instance_id |
是 |
String |
参数解释： 实例ID，此参数是实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
X-Language |
否 |
String |
参数解释： 请求语言类型。 约束限制： 不涉及。 取值范围： 默认取值： en-us。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
encryption_status |
是 |
String |
参数解释： 开启或关闭加密，不区分大小写。 约束限制： 不涉及。 取值范围： 默认取值： 不涉及。 |
|
type |
否 |
String |
参数解释： 加密类型。 约束限制： 当前只支持kms。 开启加密时必传，关闭加密时不传。不区分大小写。 取值范围： kms。 默认取值： 不涉及。 |
|
kms_key_id |
否 |
String |
参数解释： kms加密ID。加密时必传，关闭加密时候不传。 通过调用数据加密服务的创建密钥接口获取（响应参数的key_id即为加密ID）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码： 200
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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"
}
状态码
请参见状态码。
错误码
请参见错误码。
