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

Querying Tags of an ECS

Function

  • This API is used to query the tags of a specified ECS.
  • The Tag Management Service (TMS) uses this API to query all tags of an ECS.
  • This API supports checking fine-grained permissions for enterprise projects. For details, see ecs:cloudServers:showServerTags.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permissions listed below are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ecs:cloudServers:showServerTags

list

instance *

-

ecs:cloudServers:get

-

URI

GET /v1/{project_id}/cloudservers/{server_id}/tags

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

server_id

Yes

Specifies the ECS ID.

Request

None

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

tags

Array of objects

Specifies tags. For details, see Table 3.

Table 3 tags field description

Parameter

Type

Description

key

String

Specifies the tag key.

value

String

Specifies the tag value.

Example Request

Query all tags of a specified ECS.

GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags

Example Response

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

Error Codes

See Error Codes.