更新主密钥的描述信息。

将主密钥的描述信息(DescribeKey中的Description属性)替换为用户传入的值。使用此API可以对密钥的描述信息进行添加、变更、删除操作。

请求参数

名称 类型 是否必需 描述
KeyId String 主密钥(CMK)的全局唯一标识符
Description String CMK的描述性信息,通常用于描述CMK的用途,例如CMK保护的数据类型、可使用CMK的应用等。

返回参数

名称 类型 描述
RequestId String 当前请求的标志符

示例

请标志符求示例

https://kms.cn-hangzhou.aliyuncs.com/?Action=UpdateKeyDescription
&KeyId=<cmkid>
&Description=<your key description>
&<公共请求参数>

返回示例

JSON格式

//json response
{
    "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}

XML格式

//xml response
<KMS>
    <RequestId>475f1620-b9d3-4d35-b5c6-3fbdd941423d</RequestId>
</KMS>