Help Center/ Domain Name Service/ API Reference/ APIs/ Tags/ Adding a Tag to a Specific Resource

Updated on 2025-08-19 GMT+08:00

View PDF

Adding a Tag to a Specific Resource

This API is used to add a tag to a specific resource.

For details, see Calling APIs.

POST /v2/{project_id}/{resource_type}/{resource_id}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
resource_type	Yes	String	Resource type. The value can be DNS-public_zone, DNS-private_zone, DNS-public_recordset, DNS-private_recordset, or DNS-ptr_record.
resource_id	Yes	String	Resource ID

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
tag	Yes	tag object	Resource tag.

**Table 4** tag
Parameter	Mandatory	Type	Description
key	Yes	String	Definition The tag key. Range Cannot be left blank. Must be unique for each resource. Contains up to 128 characters. Cannot start or end with a space, or start with *sys*. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@
value	No	String	Definition The tag value. Range Can be left blank. Can contain a maximum of 255 characters. Only letters, digits, spaces, and the following special characters are allowed: _.:/=+-@

Status code: 204

Response to the request for adding a tag to a resource

None

Adding a tag to a specified resource

POST https://{endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags

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

None

Status Code	Description
204	Response to the request for adding a tag to a resource

Parent topic: Tags

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