Updated on 2024-03-30 GMT+08:00

Adding a Tag to a Transit IP Address

Function

  • A transit IP address can have up to 10 tags.

  • This API is idempotent.

  • If a tag to be created 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}/transit-ips/{resource_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 1

Maximum: 32

resource_id

Yes

String

Specifies the ID of the transit IP address.

Minimum: 36

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the token of a user. It is a response to the API used to obtain the token of a user. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token.

Minimum: 1

Maximum: 10240

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tag

Yes

Tag object

Specifies tags.

Table 4 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies any tag that is not included. Each tag can contain a maximum of 10 keys, and each key can contain a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys must be unique and values of a key must be unique. Resources not identified by different keys are in OR relationship, and values in one tag are in OR relationship. If no filtering condition is specified, full data is returned.

Minimum: 1

Maximum: 128

value

Yes

String

Specifies the request ID.

Minimum: 0

Maximum: 255

Response Parameters

None

Example Requests

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

POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/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.