Listing Tags of an Instance
Function
This API is used to query instance tags.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/kafka/{instance_id}/tags
| 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. |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| tags | Array of TagEntity objects | Tag list. |
| Parameter | Type | Description |
|---|---|---|
| key | String | Definition: Tag key. Constraints: Range: N/A Default Value: N/A |
| value | String | Definition: Tag value. Constraints: Range: N/A Default Value: N/A |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.