Updated on 2024-10-30 GMT+08:00

Listing Tags of an Instance

Function

This API is used to query instance tags.

URI

GET /v2/{project_id}/rabbitmq/{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.

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:

  • Must be specified.

  • Must be unique for the same instance.

  • Can contain a maximum of 36 characters.

  • Cannot contain the following special characters: =*<>,|/

  • Cannot start or end with a space.

value

String

Tag value.

  • Cannot be empty.

  • Can contain a maximum of 43 characters.

  • Cannot contain the following special characters: =*<>,|/

  • Cannot start or end with a space.

Example Requests

GET https://{endpoint}/v2/{project_id}/rabbitmq/{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.