全部产品
Search
文档中心

密钥管理服务:UpdateKeyDescription - 更新主密钥描述信息

更新时间:Aug 27, 2026

更新主密钥的描述信息。

接口说明

RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

KeyId

string

密钥 ID。主密钥的全局唯一标识符。

1234abcd-12ab-34cd-56ef-12345678****

Description

string

主密钥的描述性信息。通常用于描述主密钥的用途,例如主密钥保护的数据类型、可使用主密钥的应用等。

key description example

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

3455b9b4-95c1-419d-b310-db6a53b09a39

示例

正常返回示例

JSON格式

{
  "RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情