- API Reference
- APIs
- Tag Management
- Adding or Deleting Resource Tags in Batches
Adding or Deleting Resource Tags in Batches¶
Function¶
Add or delete tags for a specified resource in batches.
You can add up to 20 tags to a resource.
The API is idempotent.
When you are to create tags, if there are duplicate keys in the request body, an error is reported.
If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.
When tags are being deleted and some tags do not exist, the operation is considered successful by default. The character set of the tags will not be checked.
URI¶
POST /v2/{project_id}/{resource_type}/{resource_id}/tags/action
For details, see Table 1.
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. You can obtain it in Obtaining a Project ID. |
resource_type | Yes | String | Resource type.
|
resource_id | Yes | String | Resource ID |
Request¶
Parameter description
Table 2 Parameters in the request¶ Parameter
Mandatory
Type
Description
tags
Yes
Array of object
Tag list. The tag list structure cannot be empty when you delete tags. For details, see Table 3.
action
Yes
String
Operation, which can be create or delete (case sensitive)
Table 3 Parameters in the tags field¶ Parameter
Mandatory
Type
Description
key
Yes
String
Tag key
A key can contain up to 36 Unicode characters. The key cannot be empty.
value
No
String
Tag value
Each value can contain up to 43 Unicode characters and can be an empty string.
Example request
Add and delete tags for the private zone whose ID is ff8080825b8fc86c015b94bc6f8712c3:
POST https://{DNS_Endpoint}/v2/{project_id}/DNS-private_zone/ff8080825b8fc86c015b94bc6f8712c3/tags/action
{ "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }
or
{ "action": "delete", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }
Response¶
None
Returned Value¶
If a 2xx status code is returned, for example, 200, 202, or 204, the request is successful.
For details, see Status Code.