Updated on 2026-10-12 GMT+08:00

Modifying a Key Description

This API is used to modify the CMK details.

The details of the following keys cannot be modified:

Service default CMKs that end with /default

Keys that are scheduled to be deleted

For details, see Calling APIs.

POST /v1.0/{project_id}/kms/update-key-description

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
key_id	Yes	String	Definition Key ID Constraints The value must be a 36-byte ID. The value must match the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Range N/A Default Value N/A
key_description	Yes	String	Definition Key description Constraints 0 to 255 characters Range N/A Default Value N/A
sequence	No	String	Definition A 36-byte serial number of a request message, for example, 919c82d4-8046-4722-9094-35c3c6524cff. Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
key_info	KeyDescriptionInfo object	Key description.

**Table 5** KeyDescriptionInfo
Parameter	Type	Description
key_id	String	Definition Key ID Range N/A
key_description	String	Definition Key description Range N/A

Change the description of the key whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f to test.

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "key_description" : "test"
}

Status code: 200

{
  "key_info" : {
    "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "key_description" : "test"
  }
}

Status Code	Description
200	Request succeeded.