查看密鑰詳情
更新時間 2025-08-26 11:55:47
最近更新時間: 2025-08-26 11:55:47
分享文章
接口功能介紹
查看指定id的密鑰詳情
接口約束
請保證賬戶余額大于0
URI
POST /v1/keyManage/describeKey
路徑參數
無
Query參數
無
請求參數
請求頭header參數
請參見請求消息頭
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 密鑰唯一標識id | 474e569e-8814-474a-948b-dbcf6d853eff |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回碼,取值范圍: 200:成功 400:參數確實或錯誤 401:用戶驗證錯誤 404:操作目標不可用 500:系統內部錯誤 |
200 | |
| errorCode | 是 | String | 錯誤碼 | KMS.0514 | |
| msg | 是 | String | 調用結果信息 | 獲取密鑰詳情成功 | |
| data | 是 | Object | 接口返回結果 | returnObj |
表 returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| deleteDate | 是 | String | 密鑰刪除時間 | Tue Oct 25 15:06:52 CST 2022 | |
| rotationInterval | 是 | String | 輪轉周期,時間范圍為7天-730天,例如7d代表7天 | 7d | |
| nextRotationDate | 是 | String | 下次輪轉時間 | Tue Oct 25 15:06:52 CST 2022 | |
| creationDate | 是 | String | 密鑰創建時間 | Tue Oct 25 15:06:52 CST 2022 | |
| description | 是 | String | 密鑰描述,長度小于8129 | 測試 | |
| cmkUuid | 是 | String | 密鑰唯一標識id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| status | 是 | String | 密鑰狀態,取值范圍: 0:已禁用 1:啟用中 2:待刪除 3:待導入 |
1 | |
| keyUsage | 是 | String | 密鑰類型,取值范圍: 1:加密解密 2:簽名驗簽 |
1 | |
| lastRotationDate | 是 | String | 上一次輪轉時間 | Tue Oct 25 15:06:52 CST 2022 | |
| creator | 是 | String | 密鑰所屬用戶id | 562b89493b1a40e1b97ea05e50dd8170 | |
| protectionLevel | 是 | String | 密鑰保護級別,取值范圍: 0:硬件 1:軟件 |
1 | |
| origin | 是 | String | 密鑰來源,取值范圍: 1:KMS 2:外部密鑰 |
1 | |
| automaticRotation | 是 | String | 是否開啟輪轉,取值范圍: 0:已開啟 1:未開啟 2:被暫停 |
1 | |
| materialExpireTime | 是 | String | 密鑰材料過期時間 | Tue Oct 25 15:06:52 CST 2022 | |
| keySpec | 是 | String | 密鑰類型 | AES_256 | |
| isDefault | 是 | int | 是否為默認密鑰 | 1 | |
| primaryKeyVersion | 是 | String | 密鑰版本 | f2ffbff9-940a-41a4-ba9a-fe1fd8f22792 |
請求示例
請求頭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"
}
響應示例
{
"code": "200",
"errorCode": null,
"msg": "獲取密鑰詳情成功",
"data": {
"deleteDate": null,
"rotationInterval": null,
"nextRotationDate": null,
"creationDate": "Tue Oct 25 15:06:52 CST 2022",
"description": "",
"cmkUuid": "474e569e-8814-474a-948b-dbcf6d853eff",
"status": "1",
"keyUsage": "1",
"lastRotationDate": "Tue Oct 25 15:06:52 CST 2022",
"creator": "1123",
"protectionLevel": "1",
"origin": "1",
"automaticRotation": "1",
"materialExpireTime": "null",
"keySpec": "AES_256",
"isDefault": 1,
"primaryKeyVersion": "f2ffbff9-940a-41a4-ba9a-fe1fd8f22792"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
| 400 | 表示參數缺失或錯誤。 |
| 401 | 表示用戶驗證錯誤。 |
| 404 | 表示操作目標不可用。 |
| 500 | 表示系統內部錯誤。 |
錯誤碼
請參考 錯誤碼說明。