Files

qiaoli 18397ded73 kms_api_2025042703

Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: qiaoli <qiaoli@huawei.com>
Co-committed-by: qiaoli <qiaoli@huawei.com>

2025-12-09 09:29:44 +00:00

19 KiB

Raw Blame History

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 URI parameter
Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

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

Request Message

**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

Response Message

**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

Example

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

Status Codes

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

19 KiB Raw Blame History