• Key Management Service

kms
  1. Help Center
  2. Key Management Service
  3. API Reference
  4. APIs
  5. Changing the Description of a CMK

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.

URI

  • URI format

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

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    string

    Project ID

Requests

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

Response

Response parameters

Parameter

Type

Mandatory

Description

key_id

string

Yes

CMK ID

key_description

string

Yes

Description of a CMK

Examples

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"        
         }
    }

    or

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

Status Codes

Table 1 lists the normal status code returned by the response.
Table 1 Status codes

Status Code

Status

Description

200

OK

Request processed successfully.

Exception status code. For details, see Status Codes.