Help Center/ Direct Connect/ API Reference/ APIs/ Tag management/ Adding a Resource Tag

Updated on 2023-12-07 GMT+08:00

View PDF

Adding a Resource Tag

Function

A resource can have a maximum of 10 tags.
This API is idempotent.
If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path 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. dc-directconnect: 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 resource tag.

**Table 3** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. The key can contain a maximum of 36 Unicode characters, including letters, digits, hyphens (-), and underscores (_). Minimum: 0 Maximum: 36
value	No	String	Specifies the tag value. The value can contain a maximum of 43 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Minimum: 0 Maximum: 43

Response Parameters

None

Example Requests

Adding tags to a resource

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

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