请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ReplicateKey	要执行的操作，取值：ReplicateKey。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
KeyringName	String	否	test	密钥环名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]。可通过 CreateKeyring 创建密钥环时指定，或通过 DescribeKeyrings、QueryKeyring 查询获取。当不指定 KeyID 时，必须与 KeyName 同时传入；与 KeyID 二选一。
KeyName	String	否	mrk-test	主密钥名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]。可通过 CreateKey 创建密钥时指定，或通过 DescribeKeys、DescribeKey 查询获取。当不指定 KeyID 时，必须与 KeyringName 同时传入；与 KeyID 二选一。
KeyID	String	否	39a0e7c6-b7dd-4c83-b400-3449bb95403a	主密钥 ID，UUID 形式。可通过 CreateKey 创建密钥时返回，或通过 DescribeKeys、DescribeKey 查询获取。KeyID 与 KeyringName + KeyName 二选一；传入 KeyID 时无需传入 KeyringName 和 KeyName；未传入 KeyID 时，必须同时传入 KeyringName 和 KeyName。
ReplicaRegion	String	是	cn-shanghai	待复制的密钥目标地域
Description	String	否	replica key	复制地域密钥的描述
Tags	Array of Object	否	[{"Key":"region","Value":"cn-shanghai"}]	为资源绑定的标签列表，用于资源分类和管理。不传时默认不绑定任何标签。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ReplicaKey	Object	{ "ID": "d24a9f14-1a8b-4393-b66e-b77b766b5735", "CreationDate": 1625818017, "UpdateDate": 1625818017591, "KeyName": "mrk-test", "KeySpec": "SYMMETRIC_256", "Description": "replica key", "KeyState": "Enable", "KeyUsage": "ENCRYPT_DECRYPT", "ProtectionLevel": "SOFTWARE", "Origin": "CloudKMS", "MultiRegion": true, "MultiRegionConfiguration": { "MultiRegionKeyType": "REPLICA", "PrimaryKey": { "Trn": "trn:kms:cn-beijing:2100042018:keyrings/test/keys/mrk-test", "Region": "cn-beijing" }, "ReplicaKeys": [ { "Trn": "trn:kms:cn-shanghai:2100042018:keyrings/test/keys/mrk-test", "Region": "cn-shanghai" } ] } }	复制密钥的信息

请求示例

POST /?Action=ReplicateKey&Version=2021-02-18 HTTP/1.1
Host: kms.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241219T130940Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241219/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "KeyringName": "test",
  "KeyName": "mrk-test",
  "ReplicaRegion": "cn-shanghai",
  "Description": "replica key"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202412192110310861602270319AF37F",
    "Action": "ReplicateKey",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "ReplicaKey": {
      "ID": "d24a9f14-1a8b-4393-b66e-b77b766b5735",
      "CreationDate": 1625818017,
      "UpdateDate": 1625818017591,
      "KeyName": "mrk-test",
      "KeySpec": "SYMMETRIC_256",
      "Description": "replica key",
      "KeyState": "Enable",
      "KeyUsage": "ENCRYPT_DECRYPT",
      "ProtectionLevel": "SOFTWARE",
      "Origin": "CloudKMS",
      "MultiRegion": true,
      "MultiRegionConfiguration": { 
         "MultiRegionKeyType": "REPLICA",
         "PrimaryKey": { 
            "Trn": "trn:kms:cn-beijing:2100042018:keyrings/test/keys/mrk-test",
            "Region": "cn-beijing"
         },
         "ReplicaKeys": [ 
            { 
               "Trn": "trn:kms:cn-shanghai:2100042018:keyrings/test/keys/mrk-test",
               "Region": "cn-shanghai"
            }
         ]
      }
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The request parameter %s is invalid.	请求参数格式、类型或取值不合法，请根据参数说明检查并修正请求。
400	InvalidOperation	The request was rejected because the specified resource is not valid for this operation.	指定资源或当前状态不支持该操作，请确认操作对象和调用时机。
400	InvalidReplicaRegion	The replica region [%s] is not valid	外部密钥存储或相关资源配置不满足当前操作要求，请检查资源状态、网络连通性、认证凭据和参数配置后重试。
400	InvalidKeyStatus	Current key status: %s does not allow to perform this action	当前密钥状态不支持执行该操作，请检查密钥是否处于接口要求的状态。
403	Reject.Throttling.Action	The request of Action: %s upper limit is exceeded.	接口级请求频率超过限制，请降低请求速率后重试。
403	AccessDenied	User is not authorized to do this action	当前账号或子账号缺少执行该操作所需权限，请检查 IAM 授权策略。
403	KMS_ServiceNotOpen	KMS service not open yet, please open the service and try again later.	KMS 服务尚未开通，请先在控制台开通服务后重试。
404	Not Found	Not found %s [%s].	指定资源不存在或当前账号无权访问，请检查资源 ID、名称和地域是否正确。
409	Conflict	The %s resource %s is conflict.	资源已存在或当前操作与已有资源状态冲突，请检查后重试。
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.	服务内部错误，请稍后重试；如持续出现，请联系技术支持。

最近更新时间：2026.09.03 18:00:33

这个页面对您有帮助吗？

有用

无用

密钥管理系统

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求参数

返回参数

请求示例

返回示例

错误码