Deleting Resource Tags in Batches

Updated on 2024-04-03 GMT+08:00

View PDF

Function

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

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/{resource_type}/{resource_id}/tags/delete

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
project_id	String	Yes	Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.
resource_type	String	Yes	Specifies the resource type. The value can be vpn-gateway, customer-gateway, or vpn-connection.
resource_id	String	Yes	Indicates a resource ID.

Request

Request parameters

**Table 2** Request parameters
Parameter	Type	Mandatory	Description
tags	Array of ResourceTag objects	Yes	Specifies a tag list. A maximum of 20 tags can be specified.

**Table 3** ResourceTag
Parameter	Type	Mandatory	Description
key	String	Yes	Specifies a tag key. The value is a string of 1 to 128 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).
value	String	No	Specifies a tag value. The value is a string of 0 to 255 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).

Example request

DELETE https://{Endpoint}/v5/{project_id}/{resource_type}/{resource_id}/tags/delete
{
    "tags": [{
        "key": "key1",
        "value": "value1"
    }]
}

Response

Response parameters
Returned status code 204: Tags are successfully deleted.

Status Codes

For details, see Status Codes.

Parent topic: Tags

Previous topic: Adding Resource Tags in Batches

Next topic: Querying Resource Tags

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel