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

Batch Deleting Tags from a Listener

Function

This API is used to batch delete tags from a listener.

Constraints

  • A maximum of 10 tags can be added to a listener.
  • This API is idempotent.
  • Note the following when you delete tags:
    • If the tag to be deleted does not exist, the deletion is considered successful by default.
    • The value range of the tag character set is not verified.
    • The tag structure body cannot be missing, and the key cannot be left blank or set to an empty string.
    • The value of action must be delete.

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 from which a tag is to be deleted.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

Table 3 Request parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array

Specifies the tags. For details, see Table 4.

action

Yes

String

Specifies the operation identifier.

The value can be:

  • delete: deletes tags from the load balancer.
Table 4 resource_tag parameter description

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag name. The tag:

  • Cannot be left blank.
  • Can contain a maximum of 36 characters.
  • Cannot have the same key with other tags added to the same load balancer.

value

Yes

String

Specifies the tag value. The value:

  • Can contain a maximum of 43 characters.

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": "delete", 
        "tags": [
            {
                "key": "key1", 
                "value": "value1"
            }, 
            {
                "key": "key2", 
                "value": "value2"
            }
        ]
    }

Example Response

  • Example response

    None

Status Code

For details, see Status Codes.