接口功能介绍
生成数据密钥
接口约束
请保证账户余额大于0
URI
POST /v1/keyCompute/generateDataKey
路径参数
无
Query参数
无
请求参数
请求头header参数
请参见请求消息头
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 密钥唯一标识id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| keySpec | 否 | String | 指定生成的数据密钥的长度，取值范围： AES_256：256比特的对称密钥 AES_128：128比特的对称密钥 （也可通过numberOfBytes参数指定密钥长度，若均为空，默认返回AES_256) |
AES_256 | |
| numberOfBytes | 否 | String | 生成的数据密钥长度，取值范围：1-1024，单位：字节 | 256 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 |
200 | |
| errorCode | 是 | String | 错误码 | KMS.0514 | |
| msg | 是 | String | 调用结果信息 | 生成数据密钥成功 | |
| data | 是 | Object | 接口返回结果 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| plaintext | 是 | String | 数据密钥明文，且经过Base64编码后返回 | csedLEchgF5ijFx9nEc5Y0DpzWb | |
| cmkUuid | 是 | String | 密钥唯一标识id，可选对称密钥类型 | 474e569e-8814-474a-948b-dbcf6d853eff | |
| keyVersionId | 是 | String | 密钥版本id | f2ffbff9-940a-41a4-ba9a-fe1fd8f22792 | |
| ciphertextBlob | 是 | String | 数据密钥密文，即被指定CMK的主版本加密后的密文，且经过Base64编码后返回 | itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba |
请求示例
请求头header
{
"Content-Type": "application/json",
"requestDate": "20221101T154654Z",
"ctyun-eop-request-id": "89bf1559-a96e-4bc9-98fc-394d169a42e4",
"Eop-Authorization":"91ef73a6329545c294be1d5c763bdf7e Headers=ctyun-eop-request-id;eop-date Signature=2mc3zggaqLEGTSVy2H8lWsFEm+BNJf0CrcomDSOxPfc=",
"regionId":"60a39fca876e11ea91cf0242ac110002"
}
请求体body
{
"cmkUuid":"474e569e-8814-474a-948b-dbcf6d853eff",
"keySpec":"AES_256",
"numberOfBytes":"256"
}
响应示例
{
"code": "200",
"errorCode": null,
"msg": "生成数据密钥成功",
"data": {
"plaintext": "csedLEchgF5ijFx9nEc5Y0DpzWb",
"cmkUuid": "6b1f657c-816b-4534-a41a-903e7a60e703",
"keyVersionId ": "a857cc58-ab6f-40ac-b9e7-fa1781209a76",
"ciphertextBlob":"itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
| 400 | 表示参数缺失或错误。 |
| 401 | 表示用户验证错误。 |
| 404 | 表示操作目标不可用。 |
| 500 | 表示系统内部错误。 |
错误码
请参考 错误码说明。
