文档首页/ 数据加密服务 DEW/ API参考/ API说明/ 管理加密密钥/ 多区域密钥/ 复制密钥到指定区域
更新时间：2024-12-09 GMT+08:00
查看PDF
分享

复制密钥到指定区域

功能介绍

将本区域的密钥复制到指定区域。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/kms/keys/{key_id}/replicate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

key_id

是

String

待复制的密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

key_id

是

String

待复制的密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。

replica_region

是

String

复制密钥的目的区域编码。如cn-north-4。

key_alias

是

String

指定复制出的新密钥的别名。

key_description

否

String

指定复制出的新密钥的描述信息。

enterprise_project_id

否

String

指定复制出的新密钥的企业多项目ID。

  • 用户未开通企业多项目时，不需要输入该字段。

  • 用户开通企业多项目时，创建资源可以输入该字段。若用户户不输入该字段，默认创建属于默认企业多项目ID（ID为“0”）的资源。

    注意：若用户没有默认企业多项目ID（ID为“0”）下的创建权限，则接口报错。

replica_project_id

是

String

指定复制出的新密钥的项目ID。

tags

否

Array of TagItem objects

标签列表，key和value键值对的集合。
表4 TagItem

参数

是否必选

参数类型

描述

key

是

String

键。

最大长度36个unicode字符。 key不能为空。不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。

value

否

String

值。

每个值最大长度43个unicode字符，可以为空字符串。 不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

key_id

String

复制出的密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。

domain_id

String

用户域ID。

region

String

复制出的密钥所在区域编码。如cn-north-4。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表7 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表9 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表11 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表13 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表15 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 502

表16 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表17 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 504

表18 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表19 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

请求示例

{
  "key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
  "replica_region" : "cn-north-4",
  "key_alias" : "replica_key_alias",
  "replica_project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx"
}

响应示例

状态码： 200

请求已成功

{
  "key_id" : "8e85c00f-f7d0-47c9-ac96-548f977d16ba",
  "domain_id" : "3bab8e245e854f68af5967c00dd43127",
  "region" : "cn-north-4"
}

状态码

状态码

描述

200

请求已成功

400

请求参数有误

401

被请求的页面需要用户名和密码

403

认证失败

404

资源不存在，资源未找到

500

服务内部错误

502

请求未完成。服务器从上游服务器收到一个无效的响应

504

网关超时

错误码

请参见错误码。

父主题： 多区域密钥

相关文档