更新密钥描述
更新时间 2026-03-12 13:54:58
最近更新时间: 2026-03-12 13:54:58
接口功能介绍
更新密钥描述接口
接口约束
请保证账户余额大于0
URI
POST /v1/keyManage/updateKeyDescription
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 主密钥加密的数据密钥密文 | 474e569e-8814-474a-948b-dbcf6d853eff | |
| description | 否 | String | 描述 | abcd |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 返回码 取值范围：200 成功 | 200 | |
| error | String | 错误码 | KMS_0514 | |
| message | String | 调用结果信息 | 更新密钥描述成功 | |
| returnObj | Object | 接口返回结果 | null | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| requestId | String | 请求id | de413853-7a8b-42c3-a1a8-0ce1898f3476 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionId": "fecnjniakfkn2314ndekqldedcsadfg"
}
请求体body
{
"cmkUuid": "27e658cf-3b90-4987-adfd-fe8700ee4f59",
"description": "描述更改1"
}
响应示例
{
"statusCode": "200",
"message": "密钥描述数据更新成功",
"returnObj": {
"requestId": "de413853-7a8b-42c3-a1a8-0ce1898f3476"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
