Updated on 2025-07-04 GMT+08:00

Adding a Tag to a Transit Subnet

Function

This API is used to add a tag to a specified transit subnet.

A transit subnet can have up to 20 tags.

This 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.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/transit-subnets/{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 transit subnet ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

The value of X-Subject-Token in the response header is the token value.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tag

Yes

Tag object

Specifies the tag.

Table 4 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

value

Yes

String

Specifies the tag value. Each value can contain up to 255 Unicode characters.

Response Parameters

Status code: 204

Tag added.

None

Example Requests

Adding a tag to transit subnet (Setting key to key1 and value to value1)

POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-subnets/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags

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

Example Responses

None

Status Codes

Status Code

Description

204

Tag added.

Error Codes

See Error Codes.