复制凭据副本到指定区域 - CreateSecretReplica
功能介绍
在指定区域创建一个当前凭据的副本凭据,副本凭据信息会与主凭据信息保持同步
副本凭据使用指定的 kms 加密密钥加密
创建成功后主凭据的被标记为 PRIMARY,副本凭据被标记为 REPLICA
接口约束
您可以指定一个对称密钥类型的用户主密钥作为保护副本凭据的加密密钥。当不指定 kms_key_id 参数时,凭据管理服务将默认使用名为 csms/default 的默认主密钥,用于加密副本凭据。如果用户账号下不存在该名称的主密钥,则凭据管理服务会自动为您创建该名称的密钥
需要同时具备相应主密钥的 kms:dek:create 权限,用于副本凭据值进行加密
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v1/{project_id}/secrets/{secret_name}/replicas
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32 默认取值: 不涉及 |
| secret_name | 是 | String | 参数解释: 凭据名称 约束限制: 不涉及 取值范围: 需要满足正则表达式:^[a-zA-Z0-9_-]{1,64}$ 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region | 是 | String | 参数解释: 创建副本凭据的区域名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| kms_key_id | 是 | String | 参数解释: 用于加密保护凭据值的KMS主密钥ID,如果您未指定此参数,凭据管理服务将默认使用名为csms/default的默认主密钥,用于加密您账号在本项目中创建的凭据值。如果用户账号下不存在该名称的主密钥,则凭据管理服务自动为您创建该名称的密钥 约束限制: 不涉及 取值范围: 需要满足正则表达式:^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$ 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| replica_id | String | 参数解释: 多区域副本凭据 id 取值范围: 不涉及 |
请求示例
在 Region 为 cn-text-x 的区域创建一个与当前凭据名称相同的凭据副本,使用 kms 密钥 ID 为 0d0466b0-e727-xxxx-xxxx-f84bb474a37f 对副本凭据值加密
{
"region" : "cn-text-x",
"kms_key_id" : "0d0466b0-e727-xxxx-xxxx-f84bb474a37f"
} 响应示例
状态码:200
请求已成功
{
"replica_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。