Help Center/ Distributed Message Service for RabbitMQ/ API Reference/ APIs V2 (Recommended)/ Tag Management/ Batch Adding or Deleting Tags
Updated on 2026-04-21 GMT+08:00
View PDF

Batch Adding or Deleting Tags

Function

This API is used to add or delete instance tags in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/rabbitmq/{instance_id}/tags/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

No

String

Operation. Only lowercase letters are supported.

  • create: Tags are created.

  • delete: Tags are deleted.

tags

No

Array of TagEntity objects

Tag list.
Table 3 TagEntity

Parameter

Mandatory

Type

Description

key

No

String

Definition

Tag key.

Constraints

  • Cannot be left blank.

  • Must be unique for the same instance.

  • Can contain 1 to 128 characters.

  • Can contain letters, digits, spaces, and special characters _.:=+-@

  • Cannot start with sys

  • Cannot start or end with a space.

Range

N/A

Default Value

N/A

value

No

String

Definition

Tag value.

Constraints

  • Can contain 0 to 255 characters.

  • Can contain letters, digits, spaces, and special characters _.:=+-@

Range

N/A

Default Value

N/A

Response Parameters

Status code: 204

Tags are successfully added or deleted.

None

Example Requests

Creating instance tags with tag keys key1 and key2 and tag values value1 and value2

POST https://{endpoint}/v2/{project_id}/rabbitmq/{instance_id}/tags/action

{
  "action" : "create",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

Tags are successfully added or deleted.

Error Codes

See Error Codes.

Parent Topic: Tag Management