Help Center/ Elastic Cloud Server/ API Reference/ APIs (Recommended)/ Tag Management/ Querying Tags of an ECS
Updated on 2025-09-19 GMT+08:00
View PDF

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.

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"
        }
    ]
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Tag Management