• Key Management Service

kms
  1. Help Center
  2. Key Management Service
  3. API Reference
  4. APIs
  5. Querying CMK Tags

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

    Parameter

    Type

    Mandatory

    Description

    project_id

    string

    Yes

    Project ID

    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

Requests

Request parameters

None

Responses

Response parameters

Parameter

Type

Mandatory

Description

tags

JSONArray

Yes

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.

existTagNum

int

Yes

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