產生并導出數據密鑰
更新時間 2024-12-20 13:36:41
最近更新時間: 2024-12-20 13:36:41
分享文章
接口功能介紹
生成并導出數據密鑰
接口約束
請保證賬戶余額大于0
URI
POST /v1/keyCompute/generateAndExportDataKey
路徑參數
無
Query參數
無
請求參數
請求頭header參數
請參見請求消息頭
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 密鑰唯一標識id | f2ffbff9-940a-41a4-ba9a-fe1fd8f22792 | |
| keySpec | 否 | String | 指定生成數據密鑰類型,取值范圍: AES_256:256比特的對稱密鑰 AES_128:128比特的對稱密鑰 (也可通過numberOfBytes參數制定密鑰長度,若均為空,默認返回AES_256) |
AES_256 | |
| numberOfBytes | 否 | String | 指定生成的密鑰長度,取值范圍:1-1024,單位字節 | 128 | |
| publicKeyBlob | 是 | String | base64格式的公鑰 | TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF5Nk4wMlR4ZkJOL04zZE1SeVRjUAo3c1A4Nm52OUxRbDhTOTNENnZPV0hTV1l1emRMOGVtMVN6MTFwMDdJSkZiUlJpWjduRGszeUp2R3FacmxHcWZCCk9KcWJkZVFEV3FXUEdoV0Y1bVRvQUVIMnF5VEZXcDJ3NlV5TEhzSlJmaDhYQWZkWWZHZXk4QTd6Zm5lb2hjYksKWklCOUpFQ2NHRW9XdUZkcWE3Y0F0Y3VGbHMwNUxFUnZ1eXV3UlRKbWhIUCtBUmZnSEpyWUZQeDZ5TCtpaG91NApsbUhaQVZxUW1QTFNLQUlDRytqa0FFUzRkdTlKL0FvTld2UHFMZFVDQnFZVk5mL1VpR1JSa1J3cDY4Zi9qZ0ZLCjI2RnhTa0tNYnlIOVFZSXBRV2xscWxscXlmS2R5Sm94ZHFJTVhzT3MyZHNDalN1M3hzOEUwRzU2bzZYbWg3QWwKbHdJREFRQUI= | |
| wrappingAlgorithm | 是 | String | 使用publicKeyBlob所指定的公鑰,加密(Wrap)數據密鑰時的加密算法,取值范圍: RSAES_OAEP_SHA_256 RSAES_OAEP_SHA_1 |
RSAES_OAEP_SHA_256 | |
| wrappingKeySpec | 是 | String | Public_key_blob的密鑰類型,取值:RSA_2048 | RSA_2048 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回碼,取值范圍: 200:成功 400:參數缺失或錯誤 401:用戶驗證錯誤 404:操作目標不可用 500:系統內部錯誤 |
200 | |
| errorCode | 是 | String | 錯誤碼 | KMS.0514 | |
| msg | 是 | String | 調用結果信息 | 生成并導出數據密鑰成功 | |
| data | 是 | Object | 接口返回結果 | returnObj |
表 returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| exportedDataKey | 是 | String | 導出的數據密鑰密文 | AK0Fq+zuxUitFTmOpyJkJb8VsjR7t8RLFGMSLxsiuK6s6/8dyQmlI5lxCxBFDfuRT9bpLqLAlKNm7DM+NzYNNwshq1GsX7+ujaTfHIt5a4QOW5mLdnPEpdpbUfOHzXlV3pvToDC24wPJjw7KcIQMqchfOzuixXWtreEVf8LK4J1hMiVp1VuiDO2HR1dUjk+RZVsQKlZy0xf55qN4uffknp1c7bwv5Fd1mPIVzBjvjdz9h+8gTG2VVygN1uHo0tCCljQRKFGLo67y/E8Dn8qyWANWKhPl0dkjNrOtRvwm1kNK7cunPIECkpYm1lHnBPO3QPkzIC7t5dQJzu3T0iMAAg== | |
| cmkUuid | 是 | String | 密鑰唯一標識id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| keyVersionId | 是 | String | 密鑰版本id | f2ffbff9-940a-41a4-ba9a-fe1fd8f22792 | |
| ciphertextBlob | 是 | String | 數據密鑰密文 | 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":"6b1f657c-816b-4534-a41a-903e7a60e703",
"publicKeyBlob":"TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF5Nk4wMlR4ZkJOL04zZE1SeVRjUAo3c1A4Nm52OUxRbDhTOTNENnZPV0hTV1l1emRMOGVtMVN6MTFwMDdJSkZiUlJpWjduRGszeUp2R3FacmxHcWZCCk9KcWJkZVFEV3FXUEdoV0Y1bVRvQUVIMnF5VEZXcDJ3NlV5TEhzSlJmaDhYQWZkWWZHZXk4QTd6Zm5lb2hjYksKWklCOUpFQ2NHRW9XdUZkcWE3Y0F0Y3VGbHMwNUxFUnZ1eXV3UlRKbWhIUCtBUmZnSEpyWUZQeDZ5TCtpaG91NApsbUhaQVZxUW1QTFNLQUlDRytqa0FFUzRkdTlKL0FvTld2UHFMZFVDQnFZVk5mL1VpR1JSa1J3cDY4Zi9qZ0ZLCjI2RnhTa0tNYnlIOVFZSXBRV2xscWxscXlmS2R5Sm94ZHFJTVhzT3MyZHNDalN1M3hzOEUwRzU2bzZYbWg3QWwKbHdJREFRQUI=",
"wrappingAlgorithm":" RSAES_OAEP_SHA_256 ",
"wrappingKeySpec":" RSA_2048"
}
}
響應示例
{
"code": "200",
"errorCode": null,
"msg": "生成并導出數據密鑰成功",
"data": {
"exportedDataKey ": "AK0Fq+zuxUitFTmOpyJkJb8VsjR7t8RLFGMSLxsiuK6s6/8dyQmlI5lxCxBFDfuRT9bpLqLAlKNm7DM+NzYNNwshq1GsX7+ujaTfHIt5a4QOW5mLdnPEpdpbUfOHzXlV3pvToDC24wPJjw7KcIQMqchfOzuixXWtreEVf8LK4J1hMiVp1VuiDO2HR1dUjk+RZVsQKlZy0xf55qN4uffknp1c7bwv5Fd1mPIVzBjvjdz9h+8gTG2VVygN1uHo0tCCljQRKFGLo67y/E8Dn8qyWANWKhPl0dkjNrOtRvwm1kNK7cunPIECkpYm1lHnBPO3QPkzIC7t5dQJzu3T0iMAAg==",
"cmkUuid ": "6b1f657c-816b-4534-a41a-903e7a60e703",
"keyVersionId ": " a857cc58-ab6f-40ac-b9e7-fa1781209a76,
"ciphertextBlob": "itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
| 400 | 表示參數缺失或錯誤。 |
| 401 | 表示用戶驗證錯誤。 |
| 404 | 表示操作目標不可用。 |
| 500 | 表示系統內部錯誤。 |
錯誤碼
請參考 錯誤碼說明。