You need to enable JavaScript to run this app.
文档中心
密钥管理系统

密钥管理系统

复制全文
下载 pdf
密钥管理
ImportKeyMaterial - 导入密钥材料
复制全文
下载 pdf
ImportKeyMaterial - 导入密钥材料

调用本接口将外部生成并加密后的密钥材料导入到指定的 KMS 主密钥中,供后续密码学操作使用。

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String
是

ImportKeyMaterial

要执行的操作,取值:ImportKeyMaterial。

Version
String
是

2021-02-18

API的版本,取值:2021-02-18。

KeyID
String
否

39a0e7c6-b7dd-4c83-b400-3449bb95403a

主密钥 ID,UUID 形式。可通过 CreateKey 创建密钥时返回,或通过 DescribeKeys、DescribeKey 查询获取。KeyID 与 KeyringName + KeyName 二选一;传入 KeyID 时无需传入 KeyringName 和 KeyName;未传入 KeyID 时,必须同时传入 KeyringName 和 KeyName。

KeyringName
String
否

keyring-test

密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。可通过 CreateKeyring 创建密钥环时指定,或通过 DescribeKeyrings、QueryKeyring 查询获取。当不指定 KeyID 时,必须与 KeyName 同时传入;与 KeyID 二选一。

KeyName
String
否

key-test

主密钥名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。可通过 CreateKey 创建密钥时指定,或通过 DescribeKeys、DescribeKey 查询获取。当不指定 KeyID 时,必须与 KeyringName 同时传入;与 KeyID 二选一。

EncryptedKeyMaterial
String
是

aA6qb/G1OY1hjADmUXVSciJtAfNFSuUsWOpfNM+em10KLxTjyVcLdrjmes7e+ixDx4Q6I3yCEXNih/AeBCdJ63WHRglh2Zo/hefbyFGRgR5RbjIrNfi0wkeN9jnxRYU+8H/5cmaa1SEWAduPkj64zIBZMWV3A0frmTTebNOaijNC++bqEOWfU5OHtcviPWtKPWRjX17/dQBGXLhGNt+j5BTZoD5ziSciLjahwi+IpPolwPYMI7sof68tpR2JNTvIYXdcUQ8SbvrkEJLK+wpoglB8GI0ztECTuIkSfZVryykMj5SlT14Rli7PK7GU5wgXXUmdr6bz5TxU7EDtJU1thA==

使用调用GetParametersForImport获取的公钥加密并用Base64编码后的密钥材料

ImportToken
String
是

UlNBXzIwNDg6UlNBRVNfT0FFUF9TSEFfMjU2OpWOVgQfl0s2ji3Y02lzo8Z6IOEDCHFDeqEgmFECycV7WaUqYwAAAAB7pJCNwM8fEITQKnVO479+Of7Ap9PecZL7dl8XV8WNtHaPdenvVr13o/JwcbowWi5/vHWA8+ov747dlHvFMPtPZHX4ma5C9rgzD/hJfNk8vhZFeoCrpQRLes7u2oIja4bFr/Kff1A0XlILu2Xs89vSk3V/6nXhi3TfgXJSYsRZY2pHxXmcw6qll1B8vK6n1nj3mQGyYxAnZ13YRYBGmm12eTL/SmDGMgF86NTKlX/BgLJMt7NBsnHC288U1OtZ+tF9bKtRKcT6XxuhGVpLmMZmQXcRAjVnXTOAsmVIrTsCi0SvA4vJLS7C6Sww2WQ7L3nN3/EjomilLFAPuknWYk51KxWIWhoLbqQYe+j2ypx2Kixzh9LHFXw1juRF9u9JtrcQTeANPFFjbQANOJti1VgM4ySQHaAHmRBonpx0VWOFsTGrLGgikCDUh1h1lSVkcMPRWIn7EpuLlKz3BEVY6+vnTSnGTQeJY4nZohqkoDBvzvfDcVOFylIXJ9Y6HI3o9WHUw6hgpcVtSFnDWDBOnM/BeOH1mX0ZVTnZwDTy3WDvmRTT2kqk4PE+cX3WM4Q//m468RLOGAyEu0JZOc9hM0iPjhJ7dFykXrQj8PqVMhqUA/Ndtp+AVId2fYkmzgwOR90+6kdJM1ZnSki7aQWOUkTQ6gvvwFke+PDICYU8QzAeQs1NJxC4p7Cihys9xLlv3cudl4GnCKf+u40Kt5aTSMkbBYflnF+LVdVZYI7Fngd5qmx6gt9SgqOK31R64bEERj62GOmawayfOG+7xKOhGDuZyKcwa37KxYsZL1I/NYHpJlVO6Cjm7BD2ko7qwLT//MxwFzVc1fytMqneCpDnvQgvRDSattuQkCy7JazRTwzXVI5873SL0kwlXdi1fHJJxPjDl4hhC26XHbeQAZunkRZ6MWOY+rV4EmK87KfG6luykOAUKP+m4GbrV6VHindT+bCjfoc+63R7zwtiuSk21iiApPQjdWhuBkHr5CBv1vcl8oXsc7EgmRziZjsSjpJJbBsf6kD5Uq7RQeTcGIzX1v2zPYaZfvK46IpxS6/DGZCAiuLQO1Mjqq0Q21it4+osOlkz9b96FPx212yWsGXSsgC1FwL0jQbzPpD1+sa2ZCJ2e5n9yiYiJ4AlaPfgVTAiq2zExq0+S8yD4EYHeYY1AhQhcpCx63A2D3TY8d8EtDkSi5oGcLT6BF7KEzLtxF3YTPRI8puhJcUAyjFzWJYeaX6uis0RxZrCaTwafGu4xMesn6fAH1Ngxpc3dCdH1n+jnjaCnM4Lv2245VG4PLN3rHG73j7eLrtUt69MJeByL3X9z4QbxJztgg9UqrD6pBxNvv8doeRiCqtPZvh9LAMnQrTkhcSRywRM0tDVb2nDO0r8Yu6Jqs7jmsJCgl0OGQQ2ORX9RHSu59lLOD/CPzA2KomLLmPOsBtKW3XvCZCfSZxbQdlJhUc6iUoAa826ApH6pwYpjbMJHiQQ387BDUBPFdi0c52rkGPIwWH2NTrBPxRT9GjS+urBPRI/YG+cNCuap6MpzRxqecISFk2COh+ViAyRJr4orAkfO04yPAL1GL9+MTCn0ETzJIoheQV/Jt1kM2GJEmA6JsBHLhfJJM5IZq5Xo/lYQstZ/152h0qZTzt6j6NV+/FD+24NSubaPZ0n2fhIEnhc

调用GetParametersForImport获取的导入令牌

ExpirationModel
String
否

KEY_MATERIAL_DOES_NOT_EXPIRE

密钥材料的过期类型。取值:KEY_MATERIAL_DOES_NOT_EXPIRE(密钥材料不会过期,默认值)、KEY_MATERIAL_EXPIRES(密钥材料在 ValidTo 指定时间过期)。

ValidTo
Long
否

1893456000

密钥材料的有效期,Unix 秒级时间戳。当 ExpirationModel 为 KEY_MATERIAL_EXPIRES 时必须填写,且必须晚于当前服务端时间。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

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

{
  "EncryptedKeyMaterial": "aA6qb/G1OY1hjADmUXVSciJtAfNFSuUsWOpfNM+em10KLxTjyVcLdrjmes7e+ixDx4Q6I3yCEXNih/AeBCdJ63WHRglh2Zo/hefbyFGRgR5RbjIrNfi0wkeN9jnxRYU+8H/5cmaa1SEWAduPkj64zIBZMWV3A0frmTTebNOaijNC++bqEOWfU5OHtcviPWtKPWRjX17/dQBGXLhGNt+j5BTZoD5ziSciLjahwi+IpPolwPYMI7sof68tpR2JNTvIYXdcUQ8SbvrkEJLK+wpoglB8GI0ztECTuIkSfZVryykMj5SlT14Rli7PK7GU5wgXXUmdr6bz5TxU7EDtJU1thA==",
  "ImportToken": "UlNBXzIwNDg6UlNBRVNfT0FFUF9TSEFfMjU2OpWOVgQfl0s2ji3Y02lzo8Z6IOEDCHFDeqEgmFECycV7WaUqYwAAAAB7pJCNwM8fEITQKnVO479+Of7Ap9PecZL7dl8XV8WNtHaPdenvVr13o/JwcbowWi5/vHWA8+ov747dlHvFMPtPZHX4ma5C9rgzD/hJfNk8vhZFeoCrpQRLes7u2oIja4bFr/Kff1A0XlILu2Xs89vSk3V/6nXhi3TfgXJSYsRZY2pHxXmcw6qll1B8vK6n1nj3mQGyYxAnZ13YRYBGmm12eTL/SmDGMgF86NTKlX/BgLJMt7NBsnHC288U1OtZ+tF9bKtRKcT6XxuhGVpLmMZmQXcRAjVnXTOAsmVIrTsCi0SvA4vJLS7C6Sww2WQ7L3nN3/EjomilLFAPuknWYk51KxWIWhoLbqQYe+j2ypx2Kixzh9LHFXw1juRF9u9JtrcQTeANPFFjbQANOJti1VgM4ySQHaAHmRBonpx0VWOFsTGrLGgikCDUh1h1lSVkcMPRWIn7EpuLlKz3BEVY6+vnTSnGTQeJY4nZohqkoDBvzvfDcVOFylIXJ9Y6HI3o9WHUw6hgpcVtSFnDWDBOnM/BeOH1mX0ZVTnZwDTy3WDvmRTT2kqk4PE+cX3WM4Q//m468RLOGAyEu0JZOc9hM0iPjhJ7dFykXrQj8PqVMhqUA/Ndtp+AVId2fYkmzgwOR90+6kdJM1ZnSki7aQWOUkTQ6gvvwFke+PDICYU8QzAeQs1NJxC4p7Cihys9xLlv3cudl4GnCKf+u40Kt5aTSMkbBYflnF+LVdVZYI7Fngd5qmx6gt9SgqOK31R64bEERj62GOmawayfOG+7xKOhGDuZyKcwa37KxYsZL1I/NYHpJlVO6Cjm7BD2ko7qwLT//MxwFzVc1fytMqneCpDnvQgvRDSattuQkCy7JazRTwzXVI5873SL0kwlXdi1fHJJxPjDl4hhC26XHbeQAZunkRZ6MWOY+rV4EmK87KfG6luykOAUKP+m4GbrV6VHindT+bCjfoc+63R7zwtiuSk21iiApPQjdWhuBkHr5CBv1vcl8oXsc7EgmRziZjsSjpJJbBsf6kD5Uq7RQeTcGIzX1v2zPYaZfvK46IpxS6/DGZCAiuLQO1Mjqq0Q21it4+osOlkz9b96FPx212yWsGXSsgC1FwL0jQbzPpD1+sa2ZCJ2e5n9yiYiJ4AlaPfgVTAiq2zExq0+S8yD4EYHeYY1AhQhcpCx63A2D3TY8d8EtDkSi5oGcLT6BF7KEzLtxF3YTPRI8puhJcUAyjFzWJYeaX6uis0RxZrCaTwafGu4xMesn6fAH1Ngxpc3dCdH1n+jnjaCnM4Lv2245VG4PLN3rHG73j7eLrtUt69MJeByL3X9z4QbxJztgg9UqrD6pBxNvv8doeRiCqtPZvh9LAMnQrTkhcSRywRM0tDVb2nDO0r8Yu6Jqs7jmsJCgl0OGQQ2ORX9RHSu59lLOD/CPzA2KomLLmPOsBtKW3XvCZCfSZxbQdlJhUc6iUoAa826ApH6pwYpjbMJHiQQ387BDUBPFdi0c52rkGPIwWH2NTrBPxRT9GjS+urBPRI/YG+cNCuap6MpzRxqecISFk2COh+ViAyRJr4orAkfO04yPAL1GL9+MTCn0ETzJIoheQV/Jt1kM2GJEmA6JsBHLhfJJM5IZq5Xo/lYQstZ/152h0qZTzt6j6NV+/FD+24NSubaPZ0n2fhIEnhc",
  "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE",
  "ValidTo": 0
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024070821555704510919023235B46A",
    "Action": "ImportKeyMaterial",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  }
}

错误码

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

状态码
错误码
错误信息
说明
400
InvalidParameter

The request parameter %s is invalid.

请求参数格式、类型或取值不合法,请根据参数说明检查并修正请求。

400
InvalidKeyOrigin

Current key origin: %s does not allow to perform this action

密钥来源不支持当前操作,请确认密钥是否为接口要求的来源类型。

400
InvalidImportToken

Invalid import token

外部密钥存储或相关资源配置不满足当前操作要求,请检查资源状态、网络连通性、认证凭据和参数配置后重试。

400
ImportTokenRevoked

Import token used too many times

导入令牌已失效或使用次数超过限制,请重新调用 GetParametersForImport 获取导入参数。

400
InvalidKeyMaterial

Invalid key material

请求未能完成,请根据错误码、错误信息和当前资源状态检查请求后重试。

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 授权策略。

404
Not Found

Not found %s [%s].

指定资源不存在或当前账号无权访问,请检查资源 ID、名称和地域是否正确。

500
UndefinedError

Undefined Internal Error. Pls Contact With Admin.

服务内部错误,请稍后重试;如持续出现,请联系技术支持。

最近更新时间:2026.09.03 18:00:31
这个页面对您有帮助吗?
有用
有用
无用
无用