更新密鑰描述
更新時間 2025-08-26 11:55:47
最近更新時間: 2025-08-26 11:55:47
分享文章
接口功能介紹
更新密鑰描述接口
接口約束
請保證賬戶余額大于0
URI
POST /v1/keyManage/updateKeyDescription
路徑參數
無
Query參數
無
請求參數
請求頭header參數
請參見請求消息頭
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 密鑰的唯一標識id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| description | 是 | String | 描述 | abcd |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回碼,取值范圍: 200:成功 400:參數缺失或錯誤 401:用戶驗證錯誤 404:操作目標不可用 500:系統內部錯誤 |
200 | |
| errorCode | 是 | String | 錯誤碼 | KMS.0514 | |
| msg | 是 | String | 調用結果信息 | 更新密鑰描述成功 | |
| data | 是 | Object | 接口返回結果 | null |
請求示例
請求頭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",
"description":"abcd"
}
響應示例
{
"code": "200",
"errorCode": null,
"msg": "更新密鑰描述成功",
"data": null
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
| 400 | 表示參數缺失或錯誤。 |
| 401 | 表示用戶驗證錯誤。 |
| 404 | 表示操作目標不可用。 |
| 500 | 表示系統內部錯誤。 |
錯誤碼
請參考 錯誤碼說明。