Help Center/ Cloud Eye/ API Reference/ API V2/ Resource Tag Management/ Querying Tags for a Specified Resource Type in a Cloud Eye Project
Updated on 2025-10-30 GMT+08:00
View PDF
Share

Querying Tags for a Specified Resource Type in a Cloud Eye Project

Function

This API is used to query tags of a type of resources in a Cloud Eye project.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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

    ces:tags:list

    List

    -

    -
    • ces:projecttags:list

    -

URI

GET /v2/{project_id}/{resource_type}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

1 to 64 characters

Default Value

N/A

resource_type

Yes

String

Definition

Resource type.

Constraints

N/A

Range

The value can only be CES-alarm (alarm rules). It contains 1 to 32 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Definition

MIME type of the request body.

Constraints:

None

Value range:

The value can contain 1 to 64 characters.

Default value:

The default type is application/json; charset=UTF-8.

X-Auth-Token

No

String

Definition

User token.

Constraints:

None

Value range:

The value can contain 1 to 16,384 characters.

Default value:

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of TagResp objects

Definition

Tenant tags.
Table 4 TagResp

Parameter

Type

Description

key

String

Definition

Tag name.

Range

Each tag key can contain a maximum of 128 Unicode characters.

values

Array of strings

Definition

Tag value.

Range

It can contain a maximum of 255 Unicode characters. If values is not specified, any parameter value can be queried.

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  }, {
    "key" : "key2",
    "values" : [ "value1", "value2" ]
  } ]
}

Status Codes

Status Code

Description

200

OK

404

Resource not found.

Error Codes

See Error Codes.

Parent topic: Resource Tag Management