doc-exports/docs/ecs/api-ref/en-us_topic_0167811967.html
Zaoxu, Li 4edaa4a4cc ECS API 20231016 version
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-04-29 11:04:13 +00:00

9.0 KiB

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.

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.