Help Center/ Distributed Cache Service/ API Reference (Ally Region)/ APIs V2 (Recommended)/ Tag Management/ Batch Adding or Deleting Tags
Updated on 2025-12-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Batch Adding or Deleting Tags

Function

This API is used to add or delete tags in batches for a DCS instance.

URI

POST /v2/{project_id}/dcs/{instance_id}/tags/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

instance_id

Yes

String

Definition:

Instance ID. It can be viewed on the instance details page on the DCS console.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Definition:

Operation identifier.

Constraints:

N/A

Range:

  • create: Create an instance tag.

  • delete: Delete an instance tag.

Default Value:

N/A

tags

Yes

Array of ResourceTag objects

Definition:

Tag list.

Constraints:

N/A
Table 3 ResourceTag

Parameter

Mandatory

Type

Description

key

Yes

String

Definition:

Tag key.

Constraints:

  • Must be unique for each resource.

  • Contains up to 128 characters.

  • Must be unique and cannot be empty.

Range:

N/A

Default Value:

N/A

value

No

String

Definition:

Tag value.

Constraints:

  • This parameter is mandatory when action is set to create and is optional when action is set to delete.

  • Can contain a maximum of 255 characters.

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 204

Tags added or deleted successfully.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Example Requests

  • Adding tags to a specified resource in batches

    POST https://{dcs_endpoint}/v2/7dddae81f0e34f62adb9618bc8c8b1fe/dcs/01928d55-7020-4500-9c29-774caabe4bc4/tags/action

{
  "action" : "create",
  "tags" : [ {
    "value" : "2",
    "key" : "dcs001"
  }, {
    "value" : "4",
    "key" : "dcs003"
  } ]
}

  • Deleting tags from a specified instance in batches

    POST https://{dcs_endpoint}/v2/7dddae81f0e34f62adb9618bc8c8b1fe/dcs/01928d55-7020-4500-9c29-774caabe4bc4/tags/action

{
  "action" : "delete",
  "tags" : [ {
    "key" : "key1",
    "value" : "11"
  } ]
}

Example Responses

Status code: 400

Invalid request.

{
  "error_code" : "DCS.4005",
  "error_msg" : "The message body contains invalid characters or is not in JSON format."
}

Status Codes

Status Code

Description

204

Tags added or deleted successfully.

400

Invalid request.

401

Authentication failed.

403

Request rejected.

404

Incorrect path.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Tag Management