查询中转IP列表
功能介绍
查询中转IP列表。
接口约束
可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 支持参数说明中所有非必选参数过滤,请参考请求样例。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/private-nat/transit-ips
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID。 最小长度:1 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
功能说明:每页返回的个数。 取值范围:0~2000。 默认值:2000。 最小值:1 最大值:2000 缺省值:2000 |
marker |
否 |
String |
功能说明:分页查询起始的资源ID,为空时查询第一页。 值从上一次查询的PageInfo中的next_marker或者previous_marker中获取。 最小长度:36 最大长度:36 |
page_reverse |
否 |
Boolean |
是否查询前一页。 |
id |
否 |
Array |
中转IP的ID。 数组长度:1 - 10 |
project_id |
否 |
Array |
项目的ID。 数组长度:1 - 10 |
network_interface_id |
否 |
Array |
中转IP的网络接口ID。 数组长度:1 - 10 |
ip_address |
否 |
Array |
中转IP地址。 数组长度:1 - 10 |
gateway_id |
否 |
Array |
中转IP绑定的私网NAT网关实例的ID。 数组长度:1 - 10 |
enterprise_project_id |
否 |
Array |
企业项目ID。创建中转IP时,关联的企业项目ID。 数组长度:1 - 10 |
virsubnet_id |
否 |
Array |
当前租户子网的ID。 数组长度:1 - 10 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:1 最大长度:10240 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
transit_ips |
Array of TransitIp objects |
查询中转IP列表的响应体。 数组长度:0 - 2000 |
page_info |
PageInfo object |
分页信息。 |
request_id |
String |
请求ID。 最小长度:1 最大长度:36 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
中转IP的ID。 最小长度:36 最大长度:36 |
project_id |
String |
项目的ID。 最小长度:1 最大长度:36 |
network_interface_id |
String |
中转IP的网络接口ID。 最小长度:36 最大长度:36 |
ip_address |
String |
中转IP的地址。 最小长度:7 最大长度:35 |
created_at |
String |
中转IP的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ 最小长度:1 最大长度:36 |
updated_at |
String |
中转IP的更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ 最小长度:1 最大长度:36 |
virsubnet_id |
String |
当前租户子网的ID。 最小长度:0 最大长度:36 |
tags |
Array of Tag objects |
标签列表。 数组长度:1 - 10 |
gateway_id |
String |
中转IP绑定的私网NAT网关实例的ID。 最小长度:36 最大长度:36 |
enterprise_project_id |
String |
企业项目ID。创建中转IP时,关联的企业项目ID。 最小长度:1 最大长度:36 |
请求示例
GET https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/transit-ips
响应示例
状态码: 200
查询中转IP列表成功。
{ "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" }
SDK代码示例
SDK代码示例如下。
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 48 49 50 51 52 53 54 55 56 57 58 |
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.*; import java.util.List; import java.util.ArrayList; 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(); request.withLimit(<limit>); request.withMarker("<marker>"); request.withPageReverse(<page_reverse>); request.withId(); request.withNetworkInterfaceId(); request.withIpAddress(); request.withGatewayId(); request.withEnterpriseProjectId(); request.withVirsubnetId(); 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 32 33 34 35 36 37 38 39 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("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() request.limit = <limit> request.marker = "<marker>" request.page_reverse = <PageReverse> request.id = request.network_interface_id = request.ip_address = request.gateway_id = request.enterprise_project_id = request.virsubnet_id = 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 38 39 40 41 42 43 |
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{} limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest pageReverseRequest:= <page_reverse> request.PageReverse = &pageReverseRequest response, err := client.ListTransitIps(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询中转IP列表成功。 |
错误码
请参见错误码。