Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Tags/ Batch Adding or Deleting Tags of a Vault

Updated on 2024-12-20 GMT+08:00

View PDF

Batch Adding or Deleting Tags of a Vault

Function

This API is used to add or delete tags of a specific resource in batches.

TMS may use this API to manage service resource tags.

A resource can have a maximum of 10 tags. (A maximum of 20 tags can be added to a resource in the region that supports Landing Zone.)

This API is idempotent.

If there are duplicate keys in the request body when you add tags, an error is reported.

If a to-be-added tag has the same key as an existing tag, the tag will be added and will overwrite the existing tag.

When deleting tags, duplicate keys are allowed.

When deleting tags, if some tags do not exist, the deletion is considered to be successful by default. The character set of the tags will not be verified. A key and a value can each consist of up to 127 and 255 characters. The tag structure cannot be missing, and the key cannot be left blank or an empty string.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v3/{project_id}/vault/{vault_id}/tags/action

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
vault_id	Yes	String	Resource ID

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
tags	No	Array of Tag objects	Tag list This list cannot be an empty list. The list can contain up to 10 keys. Keys in this list must be unique.
sys_tags	No	Array of SysTag objects	System tag list This field is available only to the op_service permission. Choose either this field or tags. Currently, TMS calls contain only one resource_tag structure. The key is fixed at as _sys_enterprise_project_id. The value is the UUID or 0. Value 0 indicates the default enterprise project. Currently, only the create operation is supported.
action	Yes	String	Operation to be performed. The value can be set to create or delete only.

**Table 3** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Key It can contain a maximum of 36 characters. It cannot be an empty string. Spaces before and after a key will be discarded. It cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,\|/ It can contain only letters, digits, hyphens (-), and underscores (_).
value	Yes	String	Value It is mandatory when a tag is added and optional when a tag is deleted. It can contain a maximum of 43 characters. It can be an empty string. Spaces before and after a value will be discarded. It cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,\|/ It can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

**Table 4** SysTag
Parameter	Mandatory	Type	Description
key	Yes	String	Key Key of the system tag, which is obtained from the whitelist and cannot be defined randomly. Currently, only the _sys_enterprise_project_id field is supported, and the corresponding value indicates the enterprise project ID.
value	Yes	String	Value Currently, only the enterprise project ID is used. The default enterprise project ID is 0.

Response Parameters

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	For details, see Error Codes.
error_msg	String	Error message

Example Requests

Example request

POST  https://{endpoint}/v3/{project_id}/vault/{vault_id}/tags/action

{
  "tags" : [ {
    "key" : "string",
    "value" : "string"
  }, {
    "key" : "string1",
    "value" : "string2"
  } ],
  "action" : "create"
}