Help Center/ Direct Connect/ API Reference/ API/ Tag Management/ Adding a Resource Tag

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

View PDF

Adding a Resource Tag

Function

You can add up to 10 tags to a resource.
The API is idempotent.
If a tag to be added has the same key as an existing tag, the tag will be added and overwrite the existing one.

Debugging

For details, see Calling APIs.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
resource_id	Yes	String	Specifies the resource ID.
resource_type	Yes	String	Specifies the Direct Connect resource type. The value can be dc-directconnect, dc-vgw, or dc-vif. dc-directconnect: Direct Connect connection dc-vgw: virtual gateway dc-vif: virtual interface Enumeration values: dc-directconnect dc-vgw dc-vif

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
tag	Yes	Tag object	Specifies the tag.

**Table 3** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. The key: Cannot be left blank. Must be unique for each resource. Can contain a maximum of 36 Unicode characters. Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
value	No	String	Specifies the tag value. The value: Can be left blank. Can contain a maximum of 43 Unicode characters. Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).

Response Parameters

None

Example Requests

Adding a resource tag

POST https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags

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