Querying Private NAT Gateways

Function

This API is used to query private NAT gateways.

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

**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 private NAT gateway ID. Array Length: 1 - 10
name	No	Array	Specifies the private NAT gateway name. Array Length: 1 - 10
description	No	Array	Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>). Array Length: 1 - 10
spec	No	Array	Specifies the private NAT gateway type. The value can be: Small Medium Large Extra-large Array Length: 1 - 10 Enumeration values: Small Medium Large Extra-large
project_id	No	Array	Specifies the project ID. Array Length: 1 - 10
status	No	Array	Specifies the private NAT gateway status. The value can be: ACTIVE: The private NAT gateway is running properly. FROZEN: The private NAT gateway is frozen. Array Length: 1 - 10 Enumeration values: ACTIVE FROZEN
vpc_id	No	Array	Specifies the ID of the VPC where the private NAT gateway resides. Array Length: 1 - 10
virsubnet_id	No	Array	Specifies the ID of the subnet where the private NAT gateway resides. Array Length: 1 - 10
enterprise_project_id	No	Array	Specifies the ID of the enterprise project that is associated with the private NAT gateway when the private NAT gateway is created. 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
gateways	Array of PrivateNat objects	Specifies the response body for querying private NAT gateways. For details, see the PrivateNat description. Array Length: 0 - 2000
request_id	String	Specifies the request ID. Minimum: 1 Maximum: 36
page_info	PageInfo object	Specifies the pagination information.

**Table 5** PrivateNat
Parameter	Type	Description
id	String	Specifies the private NAT gateway ID. Minimum: 36 Maximum: 36
project_id	String	Specifies the project ID. Minimum: 32 Maximum: 32
name	String	Specifies the private NAT gateway name. Minimum: 1 Maximum: 64
description	String	Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>). Minimum: 0 Maximum: 255
spec	String	Specifies the private NAT gateway type. The value can be: Small Medium Large Extra-large Default: Small Enumeration values: Small Medium Large Extra-large
status	String	Specifies the private NAT gateway status. The value can be: ACTIVE: The private NAT gateway is running properly. FROZEN: The private NAT gateway is frozen. Enumeration values: ACTIVE FROZEN
created_at	String	Specifies when the private NAT gateway was created. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format.
updated_at	String	Specifies when the private NAT gateway was updated. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format.
downlink_vpcs	Array of DownlinkVpc objects	Specifies the VPC where the private NAT gateway resides. Array Length: 1 - 10
tags	Array of Tag objects	Specifies the list of tags. Array Length: 1 - 10
enterprise_project_id	String	Specifies the ID of the enterprise project that is associated with the private NAT gateway when the private NAT gateway is created. Minimum: 1 Maximum: 36

**Table 6** DownlinkVpc
Parameter	Type	Description
vpc_id	String	Specifies the ID of the VPC where the private NAT gateway resides. Minimum: 36 Maximum: 36
virsubnet_id	String	Specifies the ID of the subnet where the private NAT gateway resides. Minimum: 36 Maximum: 36

**Table 7** 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 8** 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/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways

Example Responses

Status code: 200

Private NAT gateways queried.

{
  "gateways" : [ {
    "id" : "14338426-6afe-4019-996b-3a9525296e11",
    "name" : "private-nat-gateway-name1",
    "description" : "private-nat-gateway-description1",
    "spec" : "Small",
    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "status" : "ACTIVE",
    "created_at" : "2019-04-22T08:47:13",
    "updated_at" : "2019-04-22T08:47:13",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "downlink_vpcs" : [ {
      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ]
  }, {
    "id" : "65995b8e-dcb7-4ab4-9931-bc3c95beec0a",
    "name" : "private-nat-gateway-name2",
    "description" : "private-nat-gateway-description2",
    "spec" : "Small",
    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "status" : "ACTIVE",
    "created_at" : "2019-04-22T09:06:54",
    "updated_at" : "2019-04-22T09:06:54",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "downlink_vpcs" : [ {
      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ]
  } ],
  "request_id" : "a7b00469-5a31-4274-bb10-59167243383e",
  "page_info" : {
    "previous_marker" : "14338426-6afe-4019-996b-3a9525296e11",
    "current_count" : 2
  }
}