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

16 KiB

Raw Blame History

Adding a CMK Tag

Function

This API allows you to add a CMK tag.

URI

URI format
POST /v1.0/{project_id}/kms/{key_id}/tags

Parameter description

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
key_id	Yes	String	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

Requests

**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
tag	Yes	Array of object	Tag. For details, see Table 4.
sequence	No	String	36-byte serial number of a request message Example: 919c82d4-8046-4722-9094-35c3c6524cff

**Table 4** **tag** field description
Parameter	Mandatory	Type	Description
key	Yes	String	Key. The value contains a maximum of 36 Unicode characters. The value of key cannot be empty, and cannot contain the following characters: ASCII (0-31) and *<>\=
value	Yes	String	Value. Each value contains a maximum of 43 Unicode characters and can be an empty string. The value cannot contain the following characters: ASCII (0-31) and *<>\=

Responses

None

Examples

The following example describes how to add a tag, the key and value of which are DEV and DEV1 respectively.

Example request

{   
  "tag":
     {  
        "key":"DEV",
        "value":"DEV1"
     }
}

Example response

{ 
}

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

Status Codes

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

**Table 5** Status codes
Status Code	Status	Description
204	No Content	The request is processed successfully and no content is returned.

Exception status code. For details, see Status Codes.

Parent topic: CMK Management

16 KiB Raw Blame History