• Elastic Cloud Server

ecs
  1. Help Center
  2. Elastic Cloud Server
  3. API Reference
  4. Extension ECS APIs
  5. Tag Management
  6. Adding Tags to an ECS in Batches

Adding Tags to an ECS in Batches

Function Description

  • This interface is used to add tags to a specified ECS in batches.
  • The Tag Management Service (TMS) uses this interface to batch manage the tags of an ECS.

Constraints

  • An ECS allows a maximum of 10 tags.
  • The API is idempotent.

    During tag creation, if a tag exists (both the key and value are the same as those of an existing tag), the tag is successfully processed by default.

  • A new tag will overwrite the original one if their keys are the same and values are different.

URI

POST /v1/{project_id}/servers/{server_id}/tags/action

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

Request parameters

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Mandatory

Type

Description

tags

Yes

List<resource_tag>

Specifies the tag list.

action

Yes

String

Specifies the operation. (Only lowercase letters are supported.) For example, create indicates the creation operation.

Table 3 resource_tag field description

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key.

  • Cannot be left blank.
  • Must be unique for each resource.
  • Can contain a maximum of 36 characters.
  • Can only consist of digits, letters, hyphens (-), and underscores (_).
  • The tag key must be unique and cannot be empty.

value

Yes

String

Specifies the tag value.

  • Can contain a maximum of 43 characters.
  • Can only consist of digits, letters, hyphens (-), and underscores (_).

Response

N/A

Examples

  • Example request
    POST /v1/{project_id}/servers/{server_id}/tags/action
    {
        "action": "create",
        "tags": [
            {
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key2",
                "value": "value3"
            }
        ]
    }

Returned Values

See General Request Returned Values.

Error Code

See Error Code Description.