1. 接口描述
接口请求域名: ioa.tencentcloudapi.com 。
获取用于RSA加密的公钥,对敏感数据进行加密传输。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePublicEncryptKey。 |
| Version | 是 | String | 公共参数,本接口取值:2022-06-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribePublicEncryptKeyData | 获取公钥加密的key数据 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取加密公钥
获取加密公钥
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePublicEncryptKey
<公共请求参数>
{}
输出示例
{
"Response": {
"Data": {
"PublicEncryptKey": "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQ0lqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FnOEFNSUlDQ2dLQ0FnRUFzUTNFSG9LWlA1azl6ekpXZDVLcwpRekR5UkEwMkNJNnFBZ1FrMnZGVzJBWTVNQnZtcktnVy85bW8ybzdHNDRMMDNDMXp6eFF1WktVTGlMZVlmUk9RCjN6WHF6SHlGNXlaQWRpTGYwelJTL3JFUXozNklmV0dVSWNzY1BMSnV0ME90bmNQR0Y5K2ZYU2UwVUMyU1lxUmYKMzRySVprZ1lQMTg2dEZnRkMzRmx5LzR3ZjhadXQzTFE3QTExVzQySWw4cWptY1RIQk1sOHFaS2kraUVWQXZKVgpmMVVXOG5TK3VzNUVya0JEazZ0SWQrTnQzWVUrakdtYnFFTlZoQWdzOEY2Qm1UWWk0U2E4WXZZV0F3bms1eCtzCkljb0wvZk53TDJvN1Fwd0M0YnI3L3JkT1kzNlVDcGZLWmZyd0RHeXVLeE9FaFUxTEtEbTErRFJlZFFOblBRekoKU3pyKzcwbk1VbjZzT05MK0dwWCtSc2pJUHhETHhPMHJQVUdYMlhPaTkvclp0SC9hVWMyeDVQMTFTTDErTWRyOQpHQ3gxTlNMc2JCZ2FkeW5tODNKRWVqSElxWTFReXFhY05rZis2cVprUTRzWUh5cHlQQkdwRlltdlpyL2lhbGtaCjlBM2hISzFHQ1YxOHBnZ0FXRXFodFdJeGVVNHYwUDRBRzN3ZXJPcDloWUkUytXL3drWWhiOGdoN2hyWjFENzcKcFE1V21nZlQ2c1NxcWw2ZDFicTFCNXM2RnV4UFlVak9hRDdRUzRueEtkMjQzUUc1djdGaWpaU0MzVEI3SUtEbwoyMnJLZ0YydFp4RzgxQTFtRXZ3V0VMQjNjVklselRTb0Zubk1aMXlQN1QxRXkzQU5kdXA2MEZaUUpzUVhFeDk5CmEwMk91WXphbkxBUTE5MWsyMTJ5S044Q0F3RUFBUT09Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLo="
},
"RequestId": "922ef2ea-622c-4128-9337-7d5782445ff8"
}
}
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.Unknown | 内部未知错误。 |