Changing the Description of a CMK

This API enables you to change the description of a CMK.

A Default Master Key (the alias suffix of which is /default) does not allow alias changes.
A CMK in Scheduled deletion status does not allow description changes.

Parameter description

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Content-Type	Yes	String	application/json

**Table 3** Request parameters
Parameter	Mandatory	Type	Description
key_id	Yes	String	36-byte key ID that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. For example, 0d0466b0-e727-4d9c-b35d-f84bb474a37f
key_description	Yes	String	CMK description (The value ranges from 0 to 255 characters.)
sequence	No	String	A 36-byte serial number of a request message. For example, 919c82d4-8046-4722-9094-35c3c6524cff

**Table 4** Response parameter
Parameter	Mandatory	Type	Description
key_info	Yes	Array of objects	Information about keys. For details, see Table 5.

**Table 5** **key_info** field description
Parameter	Mandatory	Type	Description
key_id	Yes	String	CMK ID
key_description	Yes	String	Description of a CMK

The following is an example about how to modify a CMK whose alias ID is bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e and description is test.

Example request

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

Example response

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

{
    "error": {
        "error_code": "KMS.XXXX",
        "error_msg": "XXX"
    }
}

Table 6 lists the normal status code returned by the response.

**Table 6** Status codes
Status Code	Status	Description
200	OK	Request processed successfully.

Exception status code. For details, see Status Codes.

Parent topic: CMK Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.