Listing Tags of an Instance

This API is used to query instance tags.

For details, see Calling APIs.

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

**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.

None

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. 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.
value	String	Tag value. Can contain 0 to 255 characters. Can contain letters, digits, spaces, and special characters _.:=+-@

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

Status code: 200

The instance tags are listed successfully.

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

Status Code	Description
200	The instance tags are listed successfully.

Parent Topic: Tag Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel