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

10 KiB

Raw Blame History

Adding Tags to an ECS

This API is used to add tags to an ECS.

You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the microversion on the client.

URI

PUT /v2.1/{project_id}/servers/{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

Table 2 describes the request parameters.

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
tags	Yes	Array of strings	Specifies ECS tags. A maximum of 50 tags can be configured, and each tag can contain up to 80 characters. Can only consist of digits, letters, hyphens (-), and underscores (_).

Response

**Table 3** Response parameters
Parameter	Mandatory	Type	Description
tags	Yes	Array of strings	Specifies ECS tags.

**Table 4** Reserved tag parameters
Tag Name	Description
__type_baremetal	Specifies that the server is a BMS.
__type_virtual	Specifies that the server is an ECS.

Example Request

Add tags to a specified ECS.

PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags

{ 
   "tags": ["baz", "foo", "qux"]
}

Example Response

{ 
   "tags": ["baz", "foo", "qux"]
}

Returned Values

See Returned Values for General Requests.

Parent topic: Tag Management

10 KiB Raw Blame History