UpdateKeyDescription_密钥管理服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
KeyIdstring

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

示例值:1234abcd-12ab-34cd-56ef-12345678****参考取值来源:
    ListKeys
    CreateKey
Descriptionstring

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

示例值:key description example

返回参数

字段名称字段详情
RequestIdstring

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

示例值:3455b9b4-95c1-419d-b310-db6a53b09a39

返回示例

变更历史

变更时间变更内容概要操作
2023-10-23
删除错误码400
删除错误码404
2022-09-22
新增错误码400
新增错误码404

相关示例

通过调用 UpdateKeyDescription 接口更新主密钥的描述信息示例
2023-03-29