更新时间:2022-08-23 GMT+08:00
修改密钥描述
功能介绍
修改用户主密钥描述信息。
- 服务默认主密钥(密钥别名后缀为“/default”)不可以修改。
- 密钥处于“计划删除”状态,密钥描述不可以修改。
URI
请求消息
参数名 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|
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 |
响应消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key_info |
是 |
Array of objects |
密钥信息,详情请参见表4。 |
示例
如下以修改密钥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" } }
父主题: API说明