Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Server Group Tag Management/ Deleting Server Group Tags in Batches
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Deleting Server Group Tags in Batches

Function

The API is idempotent.

You can delete tags from a maximum of 100 server groups at a time, and a maximum of 20 tags from a server group.

During tag deletion, if some tags to delete do not exist, the deletion is considered successful by default. The character set of the tags will not be checked.

The tag structure cannot be missing, and the key cannot be left blank or an empty string.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:serverGroup:batchDeleteTags

    Tagging

    serverGroup *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

    -

    • g:RequestTag/<tag-key>

    • g:TagKeys

URI

DELETE /v1/{project_id}/server-group/tags/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

items

Yes

Array of ServerGroupTagsInfo objects

List of tags associated with a server group.
Table 4 ServerGroupTagsInfo

Parameter

Mandatory

Type

Description

server_group_id

No

String

Unique ID of a server group.

tags

No

Array of TmsTag objects

Tag list.
Table 5 TmsTag

Parameter

Mandatory

Type

Description

key

Yes

String

Key. The value can contain a maximum of 128 Unicode characters.

  1. It can contain UTF-8 letters, digits, spaces, and the following characters: _ . : = + - @

  2. The value cannot start or end with a space.

value

No

String

Value. The value can contain a maximum of 255 Unicode characters.

  1. It can contain UTF-8 letters, digits, spaces, and the following characters: _ . : = + - @

Response Parameters

Status code: 204

Response to a successful request.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

{
  "items" : [ {
    "server_group_id" : "string",
    "tags" : [ {
      "key" : "demo01",
      "value" : "01"
    } ]
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.