文档首页> 数据加密服务 DEW> API参考（阿布扎比区域）> API说明> 管理密钥> 修改密钥描述
更新时间：2022-12-06 GMT+08:00
查看PDF

修改密钥描述

功能介绍

修改用户主密钥描述信息。

  • 服务默认主密钥（密钥别名后缀为“/default”）不可以修改。
  • 密钥处于“计划删除”状态，密钥描述不可以修改。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/update-key-description

  • 参数说明
    表1 参数说明

    参数

    是否必选

    类型

    说明

    project_id

    是

    String

    项目ID。

请求消息

表2 请求参数

参数名

参数类型

是否必选

说明

key_id

String

是

密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f

key_description

String

是

密钥描述，取值0到255字符。

sequence

String

否

请求消息序列号，36字节序列号。

例如：919c82d4-8046-4722-9094-35c3c6524cff

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

key_info

是

Array of objects

密钥信息，详情请参见表4。
表4 key_info字段结构说明

参数

参数类型

是否必选

说明

key_id

String

是

密钥ID。

key_description

String

是

密钥描述。

示例

如下以修改密钥ID为“bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e”，描述为“test”的密钥为例。

  • 请求样例
    {
    "key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "key_description": "test"     
}
  • 响应样例
    {
    "key_info": {           
        "key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
        "key_description": "test"        
     }
}

    或

    {
    "error": {
        "error_code": "KMS.XXXX",
        "error_msg": "XXX"
    }
}

状态码

表5描述的是API返回的正常状态码。
表5 状态码

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码，请参见状态码。

父主题： 管理密钥