Adding or Deleting Resource Tags in Batches

Description

Restrictions

• A maximum of 10 tags can be added to a DB instance. The tag key must be unique.
  • If the request body contains duplicated keys, an error message will be reported when the API is called.
  • If the key in the request body is the same as an existing key in the specified instance, the value of the value parameter that corresponds to the existing key is overwritten.
• If tags to be deleted do not exist, the operation is considered to be successful by default. The character set of the tags will not be checked. The tag structure in the request body cannot be missing, and the key cannot be left blank or an empty string.

URI

• URI format

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags/action

Requests

• Parameter description

  Table 2 Parameter description

  Name	Type	Mandatory	Description
  action	String	Yes	The operation identifier. Valid value: create: indicates to add tags. delete: indicates to delete tags.
  tags	Array of objects	Yes	The tag list. For more information, see Table 3. NOTE: When you delete tags, do not check the character set of this parameter.

  Table 3 tags field data structure description

  Name	Type	Mandatory	Description
  key	String	Yes	The tag key. The key cannot be empty and contains 1 to 128 single-byte characters. The key can contain UTF-8 letters (including Chinese characters), digits, spaces, and the following characters: _.:/=+-@ Do not enter labels starting with _sys_, which are system labels.
  value	String	No	The tag value. The value can contain UTF-8 letters (including Chinese characters), digits, spaces, and the following characters: _.:/=+-@ The value can be empty or null and contains 0 to 255 single-byte characters. Character set: 0-9, A-Z, a-z, "_", ".", and "-". If action is set to create, this parameter is mandatory. If action is set to delete, this parameter is optional. NOTE: If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key.

• Request example

  Add tags.

  {
    "action": "create",
    "tags": [
      {
        "key": "key1",
        "value": "value1"
      },
      {
        "key": "key",
        "value": "value3"
      }
    ]
  }
  
  

  Delete tags.

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

Responses

{}

Status Code

Error Code