查询私网NAT网关列表
功能介绍
查询私网NAT网关实例列表。
接口约束
可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
支持参数说明中所有非必选参数过滤,请参考请求样例。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/private-nat/gateways
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
功能说明:每页返回的个数。 取值范围:1~2000。 默认值:2000。 |
marker |
否 |
String |
功能说明:分页查询起始的资源ID,为空时查询第一页。 值从上一次查询的PageInfo中的next_marker或者previous_marker中获取。 |
page_reverse |
否 |
Boolean |
是否查询前一页。 |
id |
否 |
Array of strings |
私网NAT网关实例的ID。 |
name |
否 |
Array of strings |
私网NAT网关实例的名字。 |
description |
否 |
Array of strings |
私网NAT网关实例的描述。长度范围小于等于255个字符,不能包含“<”和“>”。 |
spec |
否 |
Array of strings |
私网NAT网关实例的规格。 取值为: "Small":小型 "Medium":中型 "Large":大型 "Extra-large":超大型 |
project_id |
否 |
Array of strings |
项目的ID。 |
status |
否 |
Array of strings |
私网NAT网关实例的状态。 取值为: "ACTIVE":正常运行 "FROZEN":冻结 |
vpc_id |
否 |
Array of strings |
私网NAT网关实例所属VPC的ID。 |
virsubnet_id |
否 |
Array of strings |
私网NAT网关实例所属子网的ID。 |
enterprise_project_id |
否 |
Array of strings |
企业项目ID。创建私网NAT网关实例时,关联的企业项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
gateways |
Array of PrivateNat objects |
查询私网NAT网关实例列表的响应体。 详见PrivateNat字段说明。 |
request_id |
String |
请求ID。 |
page_info |
PageInfo object |
分页信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
私网NAT网关实例的ID。 |
project_id |
String |
项目的ID。 |
name |
String |
私网NAT网关实例的名字。 |
description |
String |
私网NAT网关实例的描述。长度范围小于等于255个字符,不能包含“<”和“>”。 |
spec |
String |
私网NAT网关实例的规格。 取值为: "Small":小型 "Medium":中型 "Large":大型 "Extra-large":超大型 |
status |
String |
私网NAT网关实例的状态。 取值为: "ACTIVE":正常运行 "FROZEN":冻结 |
created_at |
String |
私网NAT网关实例的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。 |
updated_at |
String |
私网NAT网关实例的更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。 |
downlink_vpcs |
Array of DownlinkVpc objects |
私网NAT网关实例所属的VPC实例。 |
tags |
Array of Tag objects |
标签列表。 |
enterprise_project_id |
String |
企业项目ID。 创建私网NAT网关实例时,关联的企业项目ID。 |
rule_max |
Integer |
最大规则数。 |
请求示例
GET https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways
响应示例
状态码: 200
查询私网NAT网关实例列表成功
{ "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 } }
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 |
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询私网NAT网关实例列表成功 |
错误码
请参见错误码。