Updated on 2022-12-14 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 10 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 36 and 43 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

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

cluster_id

Yes

String

The cluster ID. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

Request Parameters

Table 2 Request parameters

Parameter

Mandatory

Type

Description

action

Yes

String

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

tags

Yes

Array of tag objects

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

Table 3 tags parameters

Parameter

Mandatory

Type

Description

key

Yes

String

The tag key.

  • It contains a maximum of 36 Unicode characters and cannot be an empty string.
  • The tag key of a resource must be unique.

value

Yes

String

The value.

  • The value contains a maximum of 43 Unicode characters and can be an empty string.

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" : [ {
    "tag" : null,
    "key" : "DEV1",
    "value" : "DEV1"
  }, {
    "tag" : null,
    "key" : "DEV2",
    "value" : "DEV2"
  } ],
  "x-request-examples-text-1" : "{\n    \"action\":\"create\",\n    \"tags\":[\n        {\n            \"key\":\"DEV1\",\n            \"value\":\"DEV1\"\n        }.{\n            \"key\":\"DEV2\",\n            \"value\":\"DEV2\"\n        }]\n}"
}

Example Response

None

Status Codes

See Status Codes.

Error Codes

See Error Codes.