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

Listing Tags of an Instance

Function

This API is used to query instance tags.

Debugging

You can use API Explorer to debug this API.

URI

GET /v2/{project_id}/kafka/{instance_id}/tags

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

tags

Array of TagEntity objects

Tag list.
Table 3 TagEntity

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: =*<>,|/

value

String

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/{instance_id}/tags

Example Responses

Status code: 200

The instance tags are listed successfully.

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

Status Codes

Status Code

Description

200

The instance tags are listed successfully.

Error Codes

See Error Codes.

Parent topic: Tag Management