Help Center/ Elastic Cloud Server/ API Reference/ APIs (Recommended)/ Tag Management/ Deleting Tags from an ECS in a Batch
Updated on 2026-03-18 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 20 tags.

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

Definition

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

server_id

Yes

Definition

Specifies the ECS ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of objects

Definition

Specifies tags. For details, see Table 3.

Constraints

N/A

Range

N/A

Default Value

N/A

action

Yes

String

Definition

Specifies the operation identifier.

Constraints

Only lowercase letters are supported.

Range

delete

Default Value

N/A
Table 3 tags field description

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Specifies the tag key.

Constraints

  • It cannot be left blank.
  • It must be unique for each resource.
  • It must be unique and cannot be left blank.

Range

  • A maximum of 128 characters are supported.
  • Only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF) are supported.
  • The following special characters are not supported: =*<>\,|/

Default Value

N/A

value

No

String

Definition

Specifies the tag value.

This field can be left blank.

Constraints

N/A

Range

  • A maximum of 255 characters are supported.
  • Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF) are supported.
  • The following special characters are not supported:: =*<>\,|

Default Value

N/A

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"
        }
    ]
}

Example Response

None

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Tag Management