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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the number of records displayed on each page. The value ranges from 1 to 2000. Default value: 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. |
page_reverse |
No |
Boolean |
Specifies whether to query resources on the previous page. |
id |
No |
Array of strings |
Specifies the private NAT gateway ID. |
name |
No |
Array of strings |
Specifies the private NAT gateway name. |
description |
No |
Array of strings |
Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>). |
spec |
No |
Array of strings |
Specifies the private NAT gateway specifications. The value can be:
|
project_id |
No |
Array of strings |
Specifies the project ID. |
status |
No |
Array of strings |
Specifies the private NAT gateway status. The value can be:
|
vpc_id |
No |
Array of strings |
Specifies the ID of the VPC where the private NAT gateway works. |
virsubnet_id |
No |
Array of strings |
Specifies the ID of the subnet where the private NAT gateway works. |
enterprise_project_id |
No |
Array of strings |
Specifies the ID of the enterprise project that is associated with the private NAT gateway when the private NAT gateway is created. |
Request 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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
gateways |
Array of PrivateNat objects |
Specifies the response body for querying private NAT gateways. For details, see the PrivateNat description. |
request_id |
String |
Specifies the request ID. |
page_info |
PageInfo object |
Specifies the pagination information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the private NAT gateway ID. |
project_id |
String |
Specifies the project ID. |
name |
String |
Specifies the private NAT gateway name. |
description |
String |
Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>). |
spec |
String |
Specifies the private NAT gateway specifications. The value can be:
|
status |
String |
Specifies the private NAT gateway status. The value can be:
|
created_at |
DateTime |
Specifies the time when the private NAT gateway was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format. |
updated_at |
DateTime |
Specifies the time when the private NAT gateway was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format. |
downlink_vpcs |
Array of DownlinkVpc objects |
Specifies the VPC where the private NAT gateway works. |
tags |
Array of Tag objects |
Specifies the list of tags. |
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. |
rule_max |
Integer |
Specifies the maximum number of rules. |
transit_ip_pool_size_max |
Integer |
Specifies the maximum number of transit IP addresses in a transit IP address pool. |
Parameter |
Type |
Description |
---|---|---|
vpc_id |
String |
Specifies the ID of the VPC where the private NAT gateway works. |
virsubnet_id |
String |
Specifies the ID of the subnet where the private NAT gateway works. |
ngport_ip_address |
String |
Specifies the private IP address of the private NAT gateway. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank. |
value |
String |
Specifies the tag value. Each value can contain up to 255 Unicode characters. |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
Specifies the ID of the last record in this query, which can be used in the next query. |
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. |
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. |
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", "ngport_ip_address" : "10.0.0.17" } ], "transit_ip_pool_size_max" : 1, "rule_max" : 20 }, { "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", "ngport_ip_address" : "10.0.0.18" } ], "transit_ip_pool_size_max" : 1, "rule_max" : 20 } ], "request_id" : "a7b00469-5a31-4274-bb10-59167243383e", "page_info" : { "previous_marker" : "14338426-6afe-4019-996b-3a9525296e11", "current_count" : 2 } }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.nat.v2.region.NatRegion; import com.huaweicloud.sdk.nat.v2.*; import com.huaweicloud.sdk.nat.v2.model.*; public class ListPrivateNatsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); NatClient client = NatClient.newBuilder() .withCredential(auth) .withRegion(NatRegion.valueOf("<YOUR REGION>")) .build(); ListPrivateNatsRequest request = new ListPrivateNatsRequest(); try { ListPrivateNatsResponse response = client.listPrivateNats(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdknat.v2.region.nat_region import NatRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdknat.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = NatClient.new_builder() \ .with_credentials(credentials) \ .with_region(NatRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPrivateNatsRequest() response = client.list_private_nats(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := nat.NewNatClient( nat.NatClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPrivateNatsRequest{} response, err := client.ListPrivateNats(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Private NAT gateways queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot