Updated on 2022-08-16 GMT+08:00

Deleting Tags in Batches

Function

This API is used to delete tags in batches.

URI

  • URI format

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

  • Example

    https://rds.my-kualalumpur-1.alphaedge.tmone.com.my/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/tags/action

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

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

    instance_id

    Yes

    Specifies the DB instance ID.

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    action

    Yes

    String

    Specifies the operation identifier (case sensitive), which is delete during the deletion operation.

    tags

    Yes

    Array of objects

    Specifies the tag list.

    For details, see Table 3.

    Table 3 tags field data structure description

    Name

    Mandatory

    Type

    Description

    key

    Yes

    String

    Specifies the tag key, which contains a maximum of 127 Unicode characters.

    The key cannot be left blank or an empty string.

    value

    No

    String

    Specifies the tag value, which contains a maximum of 255 Unicode characters.

    Deletion remarks:

    • If value is not empty, delete tags by key/value.
    • If value is empty, delete tags by key.
  • Request example
    {
    	"action": "delete",
    	"tags": [{
    		"key": "key1"
    	}, {
    		"key": "key2",
    		"value": "value2"
    	}]
    }

Response

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.