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

15 KiB

Raw Blame History

Querying CMK Tags

Function

This API allows you to query tags of a specified CMK.

TMS may use this API to query all tags of a specified CMK.

URI

URI format
GET /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 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}$. 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 an IAM API. The value of X-Subject-Token in the response header is the user token.

Responses

**Table 3** Response parameters
Parameter	Mandatory	Type	Description
tags	Yes	Array of objects	list of tags, including tag keys and tag values. key indicates the tag key. A CMK can have a maximum of 10 keys, and each of them is unique and cannot be empty. A key cannot have duplicate values. The value of key contains a maximum of 36 characters. value indicates the tag value. Each tag value can contain a maximum of 43 characters. The relationship between values is AND.
sys_tags	Yes	Array of objects	System tag list, which is the value pairs of key and value. key indicates the tag key. A CMK can contain at most 10 keys, and each of them is unique and cannot be empty. A key cannot have duplicate values. The value of key can contain a maximum of 36 characters. value: Tag value. The value can contain a maximum of 43 characters. A search result matches all the values.
existTagNum	Yes	Integer	Number of key tags.

Examples

The following example describes how to query CMK tags.

Example request
None

Example response

{         "tags": [
           {
            "key": "key1",
            "value": "value1"
           },
           {
            "key": "key2",
            "value": "value3"
           }
           ],
           "existTagsNum":2 
}

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

Status Codes

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

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

Exception status code. For details, see Status Codes.

Parent topic: CMK Management

15 KiB Raw Blame History