Listing Tags of an Instance¶

Function¶

This API is used to query instance tags.

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. Must be specified. Must be unique for the same instance. Can contain 1 to 128 characters. Can contain letters, digits, spaces, and special characters _.:=+-@ 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 _.:=+-@ Cannot start or end with a space.

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.

last updated: 2024-12-10 15:16 UTC - commit: ef506946dc65402760f4eb57bfda5ee36d4df62f