Help Center> Elastic Cloud Server> API Reference> APIs (Recommended)> Tag Management> Adding Tags to an ECS in a Batch
View PDF

Adding Tags to an ECS in a Batch

Function

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

Constraints

  • An ECS allows a maximum of 10 tags.
  • This 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.
  • This API supports checking fine-grained permissions for enterprise projects. For details, see ecs:cloudServers:put.

URI

POST /v1/{project_id}/cloudservers/{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.

For details about how to obtain the ID, see Obtaining a 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 objects

Specifies tags. For details, see Table 3.

action

Yes

String

Specifies the operation. (Only lowercase letters are supported.) For example, create indicates the creation operation.
Table 3 tags field description

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key.

  • Cannot be left blank.
  • Must be unique for each resource.
  • Contains a maximum of 36 characters.
  • Must be unique and cannot be left blank.

value

Yes

String

Specifies the tag value.

  • Contains a maximum of 43 characters.

Response

None

Example Request

POST  https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags/action
{
    "action": "create",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value3"
        }
    ]
}

Example Response

None

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Code Description.

Parent topic: Tag Management