Adding or Deleting Tags in Batches¶

Function¶

This API is used to add tags to or delete tags from a specified DB instance in batches. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI¶

POST /v3/{project_id}/instances/{instance_id}/tags/action

**Table 1** URI parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	DB instance ID.

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Language	No	String	Language.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
action	Yes	String	Action. Value: create delete
tags	Yes	Array of TagItem objects	Tag list.

**Table 4** TagItem¶
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. It contains a maximum of 36 Unicode characters and cannot be null, an empty string, or a space. Only digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-) are allowed.
value	No	String	Tag value. It contains a maximum of 43 Unicode characters. It can be an empty string but cannot be a space. Only digits, uppercase letters, lowercase letters, underscores (_), periods (.), and hyphens (-) are allowed. If action is set to create, this parameter is mandatory. If action is set to delete and value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key.

Response Parameters¶

Status code: 400

**Table 5** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request¶

Adding tags

POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action
{
  "action" : "create",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

Deleting tags

POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action
{
  "action" : "delete",
  "tags" : [ {
    "key" : "key1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

Example Response¶

Status code: 200

Success.

None

Status Code¶

For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-05-20 01:10