获取托管数据密钥明文。
接口说明
RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制。
本接口可以通过共享网关调用。详细介绍,请参见阿里云 SDK。
共享网关:通过公网、VPC 域名访问 KMS。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DataKeyName |
string |
否 |
托管数据密钥名称,必填 |
example-data-key |
| DataKeyVersionId |
string |
否 |
托管数据密钥版本号,可选,设置了该参数会获取指定版本号的托管数据密钥明文 |
xH6OPUmz |
| UseLatest |
boolean |
否 |
在不提供版本号的情况下,是否使用最新的托管数据密钥版本:
默认值:false |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
4bd560a1-729e-45f1-a3d9-b2a33d61046b |
| DataKeyName |
string |
托管数据密钥名称 |
example-data-key |
| DataKeyVersionName |
string |
用于存储返回的托管数据密钥版本密钥材料的对应凭据名称 |
kms-datakeyversion!example-data-key!xH6OPUmz |
| DataKeyVersionId |
string |
返回的托管数据密钥版本版本号 |
xH6OPUmz |
| Plaintext |
string |
数据密钥的明文经过 Base64 编码后的值。 |
CYueyVmZJ2MfA1VSZV2jCbFT8bO7StAvBnHacplr9aI= |
示例
正常返回示例
JSON格式
{
"RequestId": "4bd560a1-729e-45f1-a3d9-b2a33d61046b",
"DataKeyName": "example-data-key",
"DataKeyVersionName": "kms-datakeyversion!example-data-key!xH6OPUmz",
"DataKeyVersionId": "xH6OPUmz\n",
"Plaintext": "CYueyVmZJ2MfA1VSZV2jCbFT8bO7StAvBnHacplr9aI="
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。