Updated on 2025-10-24 GMT+08:00

Querying Resource Tags

Function

If there are a large number of cloud resources, you can use Tag Management Service (TMS) to manage them. Query resource information by filtering resource tags.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    coc:instance:listTagsForResource

    List

    -

    -

    • coc:instance:listResourceTags

    -

URI

GET /v1/resources/{resource_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

resource_id

Yes

String

Definition:

ID of the resource to which you want to add a tag.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

[items]

Array of TagResponse objects

Definition:

The key-value pair of a tag.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 3 TagResponse

Parameter

Type

Description

key

String

Definition:

Tag key.

Value range:

The tag key cannot start or end with a space, or start with sys. It can contain letters, digits, spaces, and the following special characters: _.:=+-@. A maximum of 128 characters are allowed.

value

String

Definition:

Tag value.

Value range:

A tag value can contain a maximum of 255 characters. It cannot start or end with a space. Only letters, digits, spaces, and the following special characters are allowed: _ . : / = + - @

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

The value contains 8 to 36 characters.

error_msg

String

Definition:

Error description.

Value range:

The value contains 2 to 512 characters.

Example Requests

This API is used to query resource tags.

GET https://{Endpoint}/v1/resources/{resource_id}/tags

Example Responses

Status code: 200

Resource tags are queried.

[ {
  "key" : "string",
  "value" : "string"
} ]

Status Codes

Status Code

Description

200

Resource tags are queried.

400

Failed to query the resource tag.

Error Codes

See Error Codes.