產生無明文返回值的數據密鑰（信封加密）
更新時間 2023-06-06 18:22:09
最近更新時間: 2023-06-06 18:22:09
分享文章
接口功能介紹
生成數據密鑰，不返回明文數據密鑰
接口約束
請保證賬戶余額大于0
URI
POST /v1/keyCompute/generateDataKeyWithoutPlaintext
路徑參數
無
Query參數
無
請求參數
請求頭header參數
請參見請求消息頭
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 密鑰唯一標識id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| keySpec | 否 | String | 指定生成的數據密鑰的長度，取值范圍： AES_256：256比特的對稱密鑰 AES_128：128比特的對稱密鑰 （也可通過numberOfByte是參數指定密鑰長度，若均為空，默認返回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
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| 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": {
"cmkUuid": "6b1f657c-816b-4534-a41a-903e7a60e703",
"keyVersionId ": "a857cc58-ab6f-40ac-b9e7-fa1781209a76",
"ciphertextBlob":"itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
| 400 | 表示參數缺失或錯誤。 |
| 401 | 表示用戶驗證錯誤。 |
| 404 | 表示操作目標不可用。 |
| 500 | 表示系統內部錯誤。 |
錯誤碼
請參考 錯誤碼說明。
