Help Center/ Enterprise Router/ API Reference/ APIs/ Tags/ Querying Resource Tags
Updated on 2025-03-31 GMT+08:00

Querying Resource Tags

Function

This API is used to query tags of resources of a specific type.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/{resource_type}/{resource_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

resource_id

Yes

String

Resource ID

resource_type

Yes

String

Tagged resource type.

  • instance: enterprise router

  • route-table: route table

  • vpc-attachment: VPC attachment

  • vgw-attachment: virtual gateway attachment

  • peering-attachment: peering connection attachment

  • vpn-attachment: VPN gateway attachment

  • gdgw-attachment: global DC gateway attachment

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

tags

Array of Tag objects

Tags

Table 3 Tag

Parameter

Type

Description

key

String

Tag key.

  • A tag key can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag key cannot be left blank.

  • A tag key can contain 1 to 128 characters.

  • Tags with the tag key starting with _sys_ are system tags and cannot be added by tenants.

Minimum: 1

Maximum: 128

value

String

Tag value.

  • A tag value can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag value can be left blank or set to null.

  • A tag value can contain 0 to 255 characters.

Minimum: 0

Maximum: 255

Example Requests

Querying tags of an enterprise router

https://{erouter_endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/f1a28dfd-186f-4625-b6b1-f05e5e8609c0/tags

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.