Updated on 2024-04-18 GMT+08:00

Batch Adding Tags to a Listener

Function

This API is used to batch add tags to a listener.

Constraints

  • A maximum of 10 tags can be added to a listener.
  • This API is idempotent.
  • Note the following when you add tags:
    • If there are duplicate keys in the request body, an error is reported.
    • If there are no duplicate keys in the request body but the key in the request body exists in the database, the key in the database is overwritten.
    • The value of action must be create.

URI

POST /v2.0/{project_id}/listeners/{listener_id}/tags/action

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 to which tags are to be added.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Table 3 Parameter description

Parameter

Mandatory

Type

Description

tags

Yes

Array

Lists the tags. For details, see Table 4.

action

Yes

String

Specifies the operation identifier.

The value can be one of the following:

  • create: adds tags to the listener.
Table 4 resource_tag parameter description

Parameter

Mandatory

Type

Description

key

Yes

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

Yes

String

Specifies the tag value.

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

Response Parameters

None

Example Request

  • Example request
    POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/7add33ad-11dc-4ab9-a50f-419703f13163/tags/action
    
    {
        "action": "create", 
        "tags": [
            {
                "key": "key1", 
                "value": "value1"
            }, 
            {
                "key": "key2", 
                "value": "value2"
            }
        ]
    }

Example Response

  • Example response

    None

Status Code

For details, see Status Codes.