Changing the Description of a CMK¶

Function¶

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

Note

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.

**Table 1** Parameter description¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Request parameters¶
Parameter	Type	Mandatory	Description
key_id	String	Yes	36-byte ID of a CMK 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}$ Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
key_description	String	Yes	CMK description (The value ranges from 0 to 255 characters.)
sequence	String	No	36-byte serial number of a request message Example: 919c82d4-8046-4722-9094-35c3c6524cff

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

**Table 4** **key_info** field description¶
Parameter	Type	Mandatory	Description
key_id	String	Yes	CMK ID
key_description	String	Yes	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 5 lists the normal status code returned by the response.

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

Exception status code. For details, see Status Codes.

last updated: 2024-11-14 08:18 UTC - commit: f0fd1483bfd6512c888b2522513eb0be99f34c59