Help Center/ Elastic Cloud Server/ API Reference/ APIs (Recommended)/ Tag Management/ Querying Tags of an ECS
Updated on 2026-03-18 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

Definition

Specifies the project ID.

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

Constraints

N/A

Range

N/A

Default Value

N/A

server_id

Yes

Definition

Specifies the ECS ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request

None

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

tags

Array of objects

Definition

Specifies tags. For details, see Table 3.

Range

A maximum of 20 tags are supported. They cannot start with _sys_.
Table 3 tags field description

Parameter

Type

Description

key

String

Definition

Specifies the tag key.

Range

  • It cannot be left blank.
  • It must be unique for each resource.
  • A maximum of 128 characters are supported.
  • Only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF) are supported.
  • The following special characters are not supported: =*<>\,|/

value

String

Definition

Specifies the tag value.

Range

  • Can be left blank.
  • A maximum of 255 characters are supported.
  • Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF) are supported.
  • The following special characters are not supported:: =*<>\,|

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