Help Center/ Elastic Cloud Server/ API Reference/ APIs/ Tag Management/ Deleting Tags from an ECS in a Batch

Updated on 2024-12-19 GMT+08:00

View PDF

Deleting Tags from an ECS in a Batch

Function

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

This API is idempotent. When you delete a tag but the tag does not exist, a successful result is returned by default.

Constraints

An ECS allows a maximum of 10 tags.

This API supports checking fine-grained permissions for enterprise projects. For details, see ecs:cloudServers:batchSetServerTags.

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, delete indicates the deletion operation.

**Table 3** **tags** field description
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. This field cannot be left blank. The tag key of an ECS must be unique.
value	No	String	Specifies the tag value. This field can be left blank.

Response

None

Example Request

Batch delete two pairs of tags from a specified ECS.

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags/action

{
    "action": "delete",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value3"
        }
    ]
}