Updated on 2026-01-20 GMT+08:00

Querying All Tags of a Listener

Function

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

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v3/{project_id}/listeners/{listener_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Constraints: N/A

Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

Default value: N/A

listener_id

Yes

String

Definition: Specifies the listener ID.

Constraints: N/A

Range: N/A

Default value: N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition: Specifies the token used for IAM authentication.

Constraints: N/A

Range: N/A

Default value: N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of ResourceTag objects

Definition: Specifies the tag list.

Table 4 ResourceTag

Parameter

Type

Description

key

String

Definition: Specifies the tag key.

Range: A key can contain a maximum of 36 Unicode characters. It cannot contain asterisks (*), angle brackets (< and >), backslashes (), equal signs (=), commas (,), vertical bars (|), or slashes (/).

value

String

Definition: Specifies the tag value.

Range: A value can contain a maximum of 255 Unicode characters. It cannot contain asterisks (*), angle brackets (< and >), backslashes (), equal signs (=), commas (,), vertical bars (|), or slashes (/).

Example Requests

GET https://{ELB_Endpoint}/v3/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/7add33ad-11dc-4ab9-a50f-419703f13163/tags

Example Responses

Status code: 200

Successful request.

{
  "tags" : [ {
    "value" : "value1",
    "key" : "key1"
  }, {
    "value" : "value3",
    "key" : "key2"
  } ]
}

Status Codes

Status Code

Description

200

Successful request.

Error Codes

See Error Codes.