Help Center> Elastic Cloud Server> API Reference> APIs (Recommended)> Tag Management> Deleting Tags from an ECS in a Batch
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.

Constraints

An ECS allows a maximum of 10 tags.

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, delete indicates the deletion operation.
Table 3 tags field description

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key.

It contains a maximum of 127 Unicode characters and cannot be left blank.

The tag key of an ECS must be unique.

value

No

String

Specifies the tag value.

It contains a maximum of 255 Unicode characters and can be left blank.

Response

None

Example Request

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags/action
{
    "action": "delete",
    "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