导入数据密钥

最近更新时间:2025-07-02 02:00:28

我的收藏

1. 接口描述

接口请求域名: kms.tencentcloudapi.com 。

数据密钥导入接口,并托管到KMS

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ImportDataKey。
Version String 公共参数,本接口取值:2019-01-18。
Region String 公共参数,详见产品支持的 地域列表
DataKeyName String 数据密钥的名称
示例值:testDataKey
ImportKeyMaterial String 如果导入的是明文数据密钥,则是base64 转换后的明文数据密钥, 如果导入的是密文数据密钥,则是由KMS GenerateDataKey接口生成的密文数据密钥。
示例值:YLbjnjPPIYjPb1XhyBYNmcx
ImportType Integer 1:密文导入(由KMS接口生成的密文数据密钥),2:明文导入。
示例值:1
Description String 数据密钥 的描述,最大100字节
示例值:描述信息
KeyId String 当导入密文数据密钥时,无需传入根密钥,如果传入会校验此KeyId是否和密文中一致。
当导入明文数据密钥,KeyId 不能为空,会根据指定的根密钥加密数据密钥。
示例值:93866e69-9755-11ef-8e65-52540089bc41
HsmClusterId String KMS 独享版对应的 HSM 集群 ID。如果指定HsmClusterId,表明根密钥在此集群里,会校验KeyId是否和HsmClusterId对应。
示例值:hsm-cluster-123

3. 输出参数

参数名称 类型 描述
KeyId String CMK的全局唯一标识
示例值:93866e69-9755-11ef-8e65-52540089bc41
DataKeyId String DataKey的全局唯一标识 否 官网/国内&国际站展示
示例值:93866e69-9755-11ef-8e65-52540089547t
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 数据密钥导入示例

输入示例

复制
复制成功
POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImportDataKey
<公共请求参数>

{
    "DataKeyName": "test_weijia_0123456",
    "ImportKeyMaterial": "MTIzNAo=",
    "ImportType": 2,
    "Description": "数据密钥导入测试",
    "KeyId": "0397abd8-4029-11f0-aa65-52540064acab"
}

输出示例

复制
复制成功
{
    "Response": {
        "DataKeyId": "eb46f9c0-5015-11f0-ace9-525400eb1719",
        "KeyId": "0397abd8-4029-11f0-aa65-52540064acab",
        "RequestId": "85568b48-a19c-43e1-9850-6d9101dc2b3a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.UnauthorizedOperation 未授权的操作。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.InvalidDataKeyName 不合法的数据密钥名称
InvalidParameterValue.InvalidImportKeyMaterial 导入的数据密钥合法
InvalidParameterValue.InvalidKeyId KeyId不合法。
InvalidParameterValue.InvalidKeyUsage KeyUsage参数错误。
InvalidParameterValue.InvalidPlaintext Plaintext不合法。
InvalidParameterValue.InvalidType Type参数错误。
LimitExceeded.CmkLimitExceeded CMK数量已达上限。
LimitExceeded.DataKeyLimitExceeded DataKey超过上限
ResourceUnavailable.CmkArchived CMK已存档。
ResourceUnavailable.CmkDisabled CMK已被禁用。
ResourceUnavailable.CmkNotFound CMK不存在。
ResourceUnavailable.CmkStateNotSupport CMK 状态不支持该操作。
ResourceUnavailable.KeyPendingDelete 不可用密钥:密钥待删除。
UnauthorizedOperation 未授权操作。

如果遇到产品相关问题,您可咨询 在线客服寻求帮助。

返回顶部