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
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 ID of the transit IP address. |
project_id |
No |
Array of strings |
Specifies the project ID. |
network_interface_id |
No |
Array of strings |
Specifies the network interface ID of the transit IP address. |
ip_address |
No |
Array of strings |
Specifies the transit IP address. |
gateway_id |
No |
Array of strings |
Specifies the ID of the private NAT gateway associated with the transit IP address. |
enterprise_project_id |
No |
Array of strings |
Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is assigned. |
virsubnet_id |
No |
Array of strings |
Specifies the subnet ID of the current tenant. |
transit_subnet_id |
No |
Array of strings |
Specifies the transit subnet ID. |
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 |
---|---|---|
transit_ips |
Array of TransitIp objects |
Specifies the response body for querying transit IP addresses. |
page_info |
PageInfo object |
Specifies the pagination information. |
request_id |
String |
Specifies the request ID. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the ID of the transit IP address. |
project_id |
String |
Specifies the project ID. |
network_interface_id |
String |
Specifies the network interface ID of the transit IP address. |
ip_address |
String |
Specifies the transit IP address. |
created_at |
DateTime |
Specifies the time when the transit IP address was assigned. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format. |
updated_at |
DateTime |
Specifies the time when the transit IP address was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format. |
virsubnet_id |
String |
Specifies the subnet ID of the current tenant. Constraint: Either this parameter or transit_subnet_id must be specified. The default value is an empty string. |
tags |
Array of Tag objects |
Specifies the list of tags. |
gateway_id |
String |
Specifies the ID of the private NAT gateway associated with the transit IP address. |
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. |
status |
String |
Specifies the transit IP address status. The value can be:
|
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/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", "status" : "ACTIVE", "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", "status" : "ACTIVE", "tags" : [ { "key" : "key1", "value" : "value1" } ] } ], "request_id" : "747a911c17067a39692f75ac146fb47e" }
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 ListTransitIpsSolution { 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(); ListTransitIpsRequest request = new ListTransitIpsRequest(); try { ListTransitIpsResponse response = client.listTransitIps(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 = ListTransitIpsRequest() response = client.list_transit_ips(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.ListTransitIpsRequest{} response, err := client.ListTransitIps(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 |
Transit IP addresses 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