1. 接口描述
接口请求域名： kms.tencentcloudapi.com 。
下载数据密钥密文
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetDataKeyCiphertextBlob。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DataKeyId | 是 | String | 数据密钥的唯一标志符 示例值：93866e69-9755-11ef-8e65-52540089bc41 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CiphertextBlob | String | 数据密钥的密文 示例值：GPJUsGlmPcSjHKIktXGyzn33yestz+7NteW36M6FuL8hPfJ1xVfdO6Akr8sF69x3yBXMwto4njumJMIsi9WKow==-k-XqqalxTyNKIC1rITRePFGQ==-k-xAL9z9eXIHV/p+WT1RsHP3dm6f43bkomXjwmvWdMXH+JQoFORTThfXgcRh1f9lPNLENK4+fCOiQVG1VvLdA0RvcuRvU= |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 下载数据密钥密文示例
下载数据密钥密文
输入示例
POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetDataKeyCiphertextBlob
<公共请求参数>
{
"DataKeyId": "cb0f16e6-4f49-11f0-b672-52540073b995"
}输出示例
{
"Response": {
"CiphertextBlob": "KoFmB5Ro70M6wfNJe1xlzriwwyn4Ypj6cjXNUbhbEE7+cAtl4ym/EIj3aAzK0Sa6GKgPzyor+zC7bUhRyB5eeQ==-k-fKVP3WIlGpg8m9LMW4jEkQ==-k-yMhT0yaoSueIApZePMxwBZ0y6EjfaKdxvvPhk9LT1ldmhb+Z",
"RequestId": "88d9d828-f019-4625-b0f7-75b57dd2e582"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameterValue.InvalidDataKeyId | 不合法的数据密钥ID |
| ResourceUnavailable.DataKeyNotFound | 数据密钥不存在 |
| ResourceUnavailable.DataKeyStateNotSupport | 数据密钥状态不支持该操作 |
