Querying the Tags of All Listeners¶

Function¶

This API is used to query the tags of all listeners.

Note

You can also use this API for dedicated load balancers.

Constraints¶

None

URI¶

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

**Table 1** Parameter description¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the ID of the project where the tag is used.

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, which are aggregated by the tag key. For details, see Table 4. For example, if you have two listeners, the tag key of both listeners is "test", the tag value of listener A is "value1", and the tag value of listener B is "value2", two tags are queried, the key of both tags is "test", and the tag values are ["value1","value2"].

**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 only the following character types: Uppercase letters Lowercase letters Digits Special characters, including hyphens (-) and underscores (_) The tag key of a listener must be unique.
values	Array	Lists the tag values. Can contain a maximum of 43 characters. Can contain only the following character types: Uppercase letters Lowercase letters Digits Special characters, including hyphens (-) and underscores (_)

Example Request¶

Example request

GET https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/tags

Example Response¶

Example response

{
    "tags": [
        {
            "key": "key1",
            "values": [
                "value1",
                "value2"
            ]
        },
        {
            "key": "key2",
            "values": [
                "value1",
                "value2"
            ]
        }
    ]
}

Status Code¶

For details, see Status Codes.

last updated: 2024-05-17 03:15