批量查詢密鑰信息
更新時間 2025-08-26 11:55:47
最近更新時間: 2025-08-26 11:55:47
分享文章
接口功能介紹
批量查詢密鑰信息
接口約束
請保證賬戶余額大于0
URI
POST /v1/keyManage/listAliasKeys
路徑參數
無
Query參數
無
請求參數
請求頭header參數
請參見請求消息頭
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| pageNumber | 是 | String | 頁數 | 1 | |
| pageSize | 是 | String | 每頁展示的密鑰數量,取值范圍:1-100 | 10 | |
| keyUsage | 否 | String | 密鑰用途,取值范圍: 1:加密解密 2:簽名驗簽(對稱密鑰不支持該用途) |
1 | |
| status | 否 | String | 密鑰狀態,取值范圍: 0:已禁用 1:啟用中 2:待刪除 3:待導入 |
1 | |
| protectionLevel | 否 | String | 密鑰保護級別,取值范圍: 0:硬件 1:軟件 |
1 | |
| keySpec | 否 | String | 密鑰的加密算法,軟件加密取值范圍: AES_256 RSA_2048 硬件加密取值范圍: AES_256 RSA_2048 Ctyun_SM2 Ctyun_SM4 |
AES_256 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回碼,取值范圍: 200:成功 400:參數缺失或錯誤 401:用戶驗證錯誤 404:操作目標不可用 500:系統內部錯誤 |
200 | |
| errorCode | 是 | String | 錯誤碼 | KMS.0514 | |
| msg | 是 | String | 調用結果信息 | 獲取密鑰列表成功 | |
| data | 是 | Object | 接口返回結果 | returnObj |
表 returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| totalCount | 是 | int | 別名總數 | 100 | |
| pageSize | 是 | String | 每頁展示的別名數量 | 10 | |
| pageNumber | 是 | String | 頁數 | 1 | |
| content | 是 | List | 密鑰信息列表 | content |
表 content
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| deletedTime | 是 | 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 | |
| createdTime | 是 | 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:被暫停 |
1 | |
| keyUsage | 是 | String | 密鑰類型,取值范圍: 1:加密解密 2:簽名驗簽 |
1 | |
| lastRotationDate | 是 | String | 上一次輪轉時間 | Tue Oct 25 15:06:52 CST 2022 | |
| userId | 是 | String | 密鑰所屬用戶id | 562b89493b1a40e1b97ea05e50dd8170 | |
| protectionLevel | 是 | String | 密鑰保護級別,取值范圍: 0:硬件 1:軟件 |
1 | |
| origin | 是 | String | 密鑰來源,取值范圍: 1:KMS 2:外部密鑰 |
1 | |
| automaticRotation | 是 | String | 是否開啟輪轉,取值范圍: 0:未開啟 1:開啟 2:被暫停 |
1 | |
| isDefault | 是 | String | 密鑰是否為默認密鑰 | 1 | |
| keySpec | 是 | String | 密鑰類型 | AES_256 | |
| aliasName | 是 | String | 密鑰別名 | ECS | |
| regionId | 是 | String | 資源池id | fecnjniakfkn2314ndekqldedcsadfg | |
| updatedTime | 是 | String | 密鑰更新時間 | 2022-10-25 15:06:53 |
請求示例
請求頭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
{
"pageNumber":"1",
"pageSize":"10",
"status":"1"
}
響應示例
{
"code": "200",
"errorCode": null,
"msg": "獲取密鑰列表成功",
"data": {
"content": [
{
"cmkUuid": "474e569e-8814-474a-948b-dbcf6d853eff",
"userId": "1123",
"origin": 1,
"protectionLevel": 1,
"automaticRotation": 1,
"rotationinTerval": null,
"createdTime": "2022-10-25 15:06:53",
"keyUsage": 1,
"status": 1,
"regionId": "123",
"description": "",
"keySpec": "AES_256",
"nextRotationDate": null,
"deletedTime": null,
"updatedTime": "2022-10-25 15:06:53",
"lastRotationDate": "2022-10-25 15:06:53",
"isDefault": 0,
"aliasName": "tdesdt_ali1adddddadcccdsasdas"
}
],
"pageNumber": 1,
"pageSize": 10,
"totalCount": 1
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
| 400 | 表示參數缺失或錯誤。 |
| 401 | 表示用戶驗證錯誤。 |
| 404 | 表示操作目標不可用。 |
| 500 | 表示系統內部錯誤。 |
錯誤碼
請參考 錯誤碼說明。