• Elastic Load Balancing

elb
  1. Help Center
  2. Elastic Load Balancing
  3. API Reference
  4. Enhanced Load Balancer APIs
  5. Tag
  6. Querying the Tags of All Listeners

Querying the Tags of All Listeners

Function

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

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.

Constraints

None

Request

  • Request parameters

    None

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

Response

  • Response parameters
    Table 2 Parameter description

    Parameter

    Type

    Description

    tags

    List

    Lists the tags, which are aggregated by the tag key. For details, see Table 3.

    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 3 tags field description

    Parameter

    Type

    Description

    key

    String

    Specifies the tag key of all listeners. The value can contain a maximum of 36 Unicode characters. It cannot be left blank or contain asterisks (*), angle brackets (< and >), backslashes (\), equal signs (=), commas (,), vertical bars (|), or slashes (/).

    values

    List

    Lists the tag values of all listeners corresponding to the tag key. Each tag value contains a maximum of 43 Unicode characters and can also be an empty string. It cannot contain asterisks (*), angle brackets (< and >), backslashes (\), equal signs (=), commas (,), vertical bars (|), or slashes (/).

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

Response Codes

For details, see Response Codes.