Updated on 2022-12-06 GMT+08:00

Querying Project Tags

Function

This API enables you to query all tag sets of a specified project.

URI

  • URI format

    GET /v1.0/{project_id}/kms/tags

  • Parameter description
    Table 1 Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID

Requests

None

Responses

Table 2 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.

Examples

The following example describes how to query project tags.

  • Example request

    None

  • Example response
    {            "tags": [
                 { 
                   "key": "key1",
                   "values": [
                       "value1",
                       "value2"
                     ]
                  },
                 {
                   "key": "key2",
                   "values": [
                       "value1",
                       "value2"
                    ]
            }
    ]
    }
    or
    {    
           "error": {        
                  "error_code": "KMS.XXXX",        
                  "error_msg": "XXX"     
         } 
    }

Status Codes

Table 3 lists the normal status code returned by the response.
Table 3 Status codes

Status Code

Status

Description

200

OK

Request processed successfully.

Exception status code. For details, see Status Codes.