Help Center> Distributed Message Service for Kafka> API Reference> APIs V2 (Recommended)> Tag Management> Listing Tags of a Project
View PDF

Listing Tags of a Project

Function

This API is used to query project tags.

Debugging

You can use API Explorer to debug this API.

URI

GET /v2/{project_id}/kafka/tags

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

tags

Array of TagMultyValueEntity objects

Tag list.
Table 3 TagMultyValueEntity

Parameter

Type

Description

key

String

Tag key, which can contain a maximum of 36 Unicode characters.

The key cannot be left blank or an empty string.

It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/

values

Array of strings

Tag value, which can contain a maximum of 43 Unicode characters.

The value cannot be left blank but can be an empty string.

It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/

Example Requests

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

Example Responses

Status code: 200

The project tags are listed successfully.

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

Status Codes

Status Code

Description

200

The project tags are listed successfully.

Error Codes

See Error Codes.

Parent topic: Tag Management