Changing the Description of a CMK

Function

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.

URI

• URI format

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

• Parameter description

  Table 1 Parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID

Requests

Responses

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

Exception status code. For details, see Status Codes.