Updated on 2024-11-29 GMT+08:00

Deleting Tags from a Cluster in Batches

Function

This API is used to delete tags from a specified cluster in batches.

A cluster can have a maximum of 20 tags.

This API is idempotent.

  • When tags are being deleted and some tags do not exist, the operation is considered to be successful by default. The character set of the tags will not be checked. A key and a value can respectively contain up to 128 and 255 Unicode characters. The tags structure cannot be missing. The key cannot be empty or an empty string.

URI

POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation

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

Constraints

N/A

Value range

The value must consist of 1 to 64 characters. Only letters and digits are allowed.

Default value

N/A

cluster_id

Yes

String

Explanation

Cluster ID. If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

Constraints

N/A

Value range

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Explanation

Operation to be performed. The value can be delete only.

Constraints

N/A

Value range

  • delete: Delete a tag.

Default value

N/A

tags

Yes

Array of tag objects

Explanation

The tag list. For details about the parameter, see Table 3.

Constraints

N/A

Table 3 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Tag key.

  • The value can contain a maximum of 128 characters and cannot be an empty string.
  • The tag key of a resource must be unique.
  • A tag key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.

value

Yes

String

Explanation

Tag key.

Constraints

N/A

Value range

  • The value can contain a maximum of 128 characters and cannot be an empty string.
  • The tag key of a resource must be unique.
  • A tag key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.

Default value

N/A

Explanation

Tag value.

Constraints

N/A

Value range

  • The value can contain a maximum of 255 characters and can be an empty string.
  • A tag value can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.

Default value

N/A

Response Parameters

None

Example Request

Delete tags from a cluster in batches.

POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action

{
  "action" : "delete",
  "tags" : [ {
    "key" : "DEV1",
    "value" : "DEV1"
  }, {
    "key" : "DEV2",
    "value" : "DEV2"
  } ]
}

Example Response

None

Status Codes

See Status Codes.

Error Codes

See Error Codes.