Updated on 2026-09-29 GMT+08:00

Adding a Tag to an Associated Resource

Function

This API is used to add tags to a vault. A resource can have a maximum of 10 tags. (A resource in a region supporting landing zone can have up to 20 tags.)

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
vault_id	Yes	String	Definition Vault ID. For details about how to obtain the vault ID, see Querying the Vault List. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
tag	Yes	TagCreate object	Tags

**Table 3** TagCreate
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. A key consists of up to 36 characters. A key cannot be an empty string. Spaces before and after a key will be discarded. A key cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). A key can contain only letters, digits, hyphens (-), and underscores (_). When creating tags, if the request body contains duplicate keys, an error will be reported. When creating tags, if a new tag's key duplicates an existing tag's key, the new tag overwrites the existing one. When deleting tags, duplicate keys are allowed. When deleting tags, non-existent tags are treated as successfully deleted by default. The character set of tags is not verified. When deleting tags, the tags* structure must be provided, and key cannot be null or an empty string.
value	Yes	String	Tag value. A value is mandatory when a tag is added and optional when a tag is deleted. A value consists of up to 43 characters. A value can be an empty string. Spaces before and after a value will be discarded. A value cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). A value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

Response Parameters

Status code: 204

None

Status code: 400

**Table 4** 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

{
  "tag" : {
    "key" : "key1",
    "value" : "key2"
  }
}

Example Responses

None

Status Codes

Status Code	Description
204	No Content
400	Bad Request

Error Codes

See Error Codes.

Parent topic: Tags