• Elastic Cloud Server

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

Deleting Tags from an ECS in Batches

Function Description

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

The 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.

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

Table 3 resource_tag 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.

The value can contain a maximum of 255 Unicode characters and can be left blank.

Response

N/A

Examples

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

Returned Values

See General Request Returned Values.

Error Code

See Error Code Description.