Help Center/ Distributed Message Service for RocketMQ/ API Reference/ APIs V2 (Recommended)/ Tag Management/ Querying Project Tags
Updated on 2026-04-30 GMT+08:00
View PDF

Querying Project Tags

Function

This API is used to query tags of a project.

URI

GET /v2/{project_id}/rocketmq/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total

Number

Definition

Total number.

Constraints

N/A

Range

N/A

Default Value

N/A

next_offset

Integer

Definition

Offset of the next page.

Constraints

N/A

Range

N/A

Default Value

N/A

previous_offset

Integer

Definition

Offset of the previous page.

Constraints

N/A

Range

N/A

Default Value

N/A

tags

Array of TagMultyValueEntity objects

Definition

Tag list.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 TagMultyValueEntity

Parameter

Type

Description

key

String

Definition

Tag key.

Constraints

N/A

Range

N/A

Default Value

N/A

values

Array of strings

Definition

Tag value.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

Querying project tags

GET https://{endpoint}/v2/{project_id}/rocketmq/tags

Example Responses

Status code: 200

The project tags are queried successfully.

{
  "total" : 1,
  "next_offset" : -1,
  "previous_offset" : -1,
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value-test", "value1" ]
  }, {
    "key" : "key2",
    "values" : [ "value2" ]
  } ]
}

Status Codes

Status Code

Description

200

The project tags are queried successfully.

Error Codes

See Error Codes.

Parent Topic: Tag Management