Updated on 2023-06-20 GMT+08:00

Adding or Deleting Cluster Tags in Batches

Function

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

URI

POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

cluster_id

Yes

String

ID of the cluster that you want to add tags to or delete tags from in batches.

resource_type

Yes

String

Resource type. Currently, its value can only be css-cluster.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Action type. This attribute is used to identify the required operation type.

  • create: Tags are added in batches.
  • delete: Tags are deleted in batches.

tags

Yes

Array of Tag objects

Tag list.

sysTags

No

Array of SysTags objects

System tag list.

  • The value of key is fixed to _sys_enterprise_project_id.
  • The value is UUID or 0. 0 indicates the default enterprise project.
Table 3 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Tag name.

value

Yes

String

Tag value.

Table 4 SysTags

Parameter

Mandatory

Type

Description

key

Yes

String

Tag name.

value

Yes

String

Tag value.

Response Parameters

None

Example Requests

{
  "action" : "create",
  "tags" : [ {
    "key" : "K1",
    "value" : "V1"
  }, {
    "key" : "K2",
    "value" : "V2"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

Request succeeded.

400

Invalid request.

Do not retry the request before modification.

409

The request could not be completed due to a conflict with the current state of the resource.

This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.

412

The server did not meet one of the preconditions contained in the request.

Error Codes

See Error Codes.