Querying Transit IP Addresses

Function

This API is to query transit IP addresses.

Constraints

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. All optional parameters can be filtered. For details, see the example request.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/private-nat/transit-ips

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. Minimum: 1 Maximum: 36

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the number of records displayed on each page. The value ranges from 0 to 2000. Default value: 2000 Minimum: 1 Maximum: 2000 Default: 2000
marker	No	String	Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. The value is obtained from next_marker or previous_marker in PageInfo queried last time. Minimum: 36 Maximum: 36
page_reverse	No	Boolean	Specifies whether to query resources on the previous page.
id	No	Array	Specifies the ID of the transit IP address. Array Length: 1 - 10
project_id	No	Array	Specifies the project ID. Array Length: 1 - 10
network_interface_id	No	Array	Specifies the network interface ID of the transit IP address. Array Length: 1 - 10
ip_address	No	Array	Specifies the transit IP address. Array Length: 1 - 10
gateway_id	No	Array	Specifies the ID of the private NAT gateway associated with the transit IP address. Array Length: 1 - 10
enterprise_project_id	No	Array	Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is being assigned. Array Length: 1 - 10
virsubnet_id	No	Array	Specifies the subnet ID of the current tenant. Array Length: 1 - 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It is a response to the API used to obtain 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. Minimum: 1 Maximum: 10240

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
transit_ips	Array of TransitIp objects	Specifies the response body for querying transit IP addresses. Array Length: 0 - 2000
page_info	PageInfo object	Specifies the pagination information.
request_id	String	Specifies the request ID. Minimum: 1 Maximum: 36

**Table 5** TransitIp
Parameter	Type	Description
id	String	Specifies the ID of the transit IP address. Minimum: 36 Maximum: 36
project_id	String	Specifies the project ID. Minimum: 1 Maximum: 36
network_interface_id	String	Specifies the network interface ID of the transit IP address. Minimum: 36 Maximum: 36
ip_address	String	Specifies the transit IP address. Minimum: 7 Maximum: 35
created_at	String	Specifies when the transit IP address was assigned. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. Minimum: 1 Maximum: 36
updated_at	String	Specifies when the transit IP address was updated. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. Minimum: 1 Maximum: 36
virsubnet_id	String	Specifies the subnet ID of the current tenant. Minimum: 0 Maximum: 36
tags	Array of Tag objects	Specifies the list of tags. Array Length: 1 - 10
gateway_id	String	Specifies the ID of the private NAT gateway associated with the transit IP address. Minimum: 36 Maximum: 36
enterprise_project_id	String	Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is being assigned. Minimum: 1 Maximum: 36

**Table 6** Tag
Parameter	Type	Description
key	String	Specifies the tag key. Minimum: 1 Maximum: 128
value	String	Specifies the tag value. Minimum: 0 Maximum: 255

**Table 7** PageInfo
Parameter	Type	Description
next_marker	String	Specifies the ID of the last record in this query, which can be used in the next query. Minimum: 1 Maximum: 36
previous_marker	String	Specifies the ID of the first record in the pagination query result. When page_reverse is set to true, this parameter is used together to query resources on the previous page. Minimum: 1 Maximum: 36
current_count	Integer	Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page. Minimum: 1 Maximum: 2000

Example Requests

GET https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/transit-ips

Example Responses

Status code: 200

Transit IP addresses queried.

{
  "transit_ips" : [ {
    "id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
    "project_id" : "da261828016849188f4dcc2ef94d9da9",
    "network_interface_id" : "c91c43fb-8d66-48df-bfa9-b89053ac3737",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "gateway_id" : "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
    "ip_address" : "192.168.1.68",
    "created_at" : "2019-04-29T03:41:59",
    "updated_at" : "2019-04-29T03:41:59",
    "virsubnet_id" : "49ee5fb5-75bf-4320-946e-b21ef4c9c9c1",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  }, {
    "id" : "a2845109-3b2f-4627-b08f-09a726c0a6e7",
    "project_id" : "da261828016849188f4dcc2ef94d9da9",
    "network_interface_id" : "adebbdca-8c26-4c14-b34f-3f53cd2c42f2",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "gateway_id" : "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
    "ip_address" : "192.168.1.68",
    "created_at" : "2019-04-29T02:16:09",
    "updated_at" : "2019-04-29T02:16:09",
    "virsubnet_id" : "333e5fb5-75bf-4320-946e-b21ef4c9c2g5",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  } ],
  "request_id" : "747a911c17067a39692f75ac146fb47e"
}