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

Querying Tags of a Transit IP Address

Function

  • This API is used to query tags of a specified transit IP address.

  • TMS uses this API to query all tags of a specified transit IP address.

Calling Method

For details, see Calling APIs.

URI

GET /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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

Minimum: 1

Maximum: 36

tags

Array of Tag objects

Tags

Array Length: 1 - 10

Table 4 Tag

Parameter

Type

Description

key

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

String

Specifies the request ID.

Minimum: 0

Maximum: 255

Example Requests

GET  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/b0399473-c352-4d0c-8ff4-cfde719cfde9/tags

Example Responses

Status code: 200

Query operation succeeded.

{
  "request_id" : "80ef5f21-b81a-4546-b23d-84272507d330",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  }, {
    "key" : "key3",
    "value" : "value3"
  } ]
}

Status Codes

Status Code

Description

200

Query operation succeeded.

Error Codes

See Error Codes.