Deleting Protected Instance Tags in Batches

Function

This API is used to delete protected instance tags for a specified protected instance in batches.

You can add a maximum of 10 tags to a protected instance.

This API is idempotent.

During tag deletion, if some tags do not exist, the operation is considered to be successful by default. The character set of the tags will not be checked. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.

URI

URI format
POST /v1/{project_id}/protected-instances/{protected_instance_id}/tags/action

Parameter description

Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
protected_instance_id	Yes	String	Specifies the ID of a protected instance. For details, see Querying Protected Instances.

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

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

protected_instance_id

Yes

String

Specifies the ID of a protected instance.

For details, see Querying Protected Instances.

Request

Parameter description

Parameter	Mandatory	Type	Description
action	Yes	String	Identifies the operation. The value can be create or delete. delete: indicates to delete a tag.
tags	Yes	Array of objects	Specifies the tag list. For details, see Table 1.

Parameter

Mandatory

Type

Description

action

Yes

String

Identifies the operation. The value can be create or delete.

delete: indicates to delete a tag.

tags

Yes

Array of objects

Specifies the tag list.

For details, see Table 1.

**Table 1** **resource_tag** field description
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. The tag key of a resource must be unique. It can contain up to 36 Unicode characters. The key cannot be left blank or be an empty string. It cannot contain non-printable ASCII characters (0–31) or special characters, including asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), equal signs (=), commas (,), vertical bars (\|), and slashes (/). The key cannot be left blank, and must be unique for each resource.
value	No	String	Specifies the tag value. The value contains a maximum of 43 Unicode characters. If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key. The value cannot be left blank but can be an empty string. It cannot contain non-printable ASCII characters (0–31) or special characters, including asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), equal signs (=), commas (,), vertical bars (\|), and slashes (/).

Example request

POST https://{Endpoint}/v1/{project_id}/protected-instances/67a2cc7e-fb87-41a8-ba28-9c032abcaee1/tags/action

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