Updated on 2023-12-18 GMT+08:00

Querying All Tags of a Listener

Function

This API is used to query all tags of one listener.

Constraints

None

URI

GET /v2.0/{project_id}/listeners/{listener_id}/tags

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the ID of the project where the tag is used.

listener_id

Yes

String

Specifies the ID of the listener whose tags are to be queried.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Table 3 Response parameters

Parameter

Type

Description

tags

Array

Lists the tags. For details, see Table 4.

Table 4 tags parameter description

Parameter

Type

Description

key

String

Specifies the tag key.

  • Cannot be left blank.
  • Can contain a maximum of 36 characters.
  • Can contain letters, digits, underscores (_), and hyphens (-).
  • The tag key of a listener must be unique.

value

String

Specifies the tag value.

  • Can contain a maximum of 43 characters.
  • Can contain letters, digits, underscores (_), periods (.), and hyphens (-).

Example Request

  • Example request
    GET https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/7add33ad-11dc-4ab9-a50f-419703f13163/tags

Example Response

  • Example response
    {
        "tags": [
            {
                "key": "key1", 
                "value": "value1"
            }, 
            {
                "key": "key2", 
                "value": "value2"
            }
        ]
    }

Status Code

For details, see Status Codes.