UpdateKeyDescription - Key Management Service - Alibaba Cloud Documentation Center

Operation description

This operation replaces the description of a customer master key (CMK) with the description that you specify. The original description of the CMK is specified by the Description parameter when you call the DescribeKey operation. Use this operation to add, modify, or delete the description of a CMK.

For more information about the access policy required for a RAM user or RAM role to call this operation, see Resource Access Management.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
KeyId	string	Yes	The ID of the CMK. The ID must be globally unique.	1234abcd-12ab-34cd-56ef-12345678****
Description	string	Yes	The description of the CMK. This description includes the purpose of the CMK, such as the types of data that you want to protect and applications that can use the CMK.	key description example

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	3455b9b4-95c1-419d-b310-db6a53b09a39

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.