查询SNAT规则列表
功能介绍
查询SNAT规则列表。
接口约束
可以在URI后面用'?'和'&'添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求样例。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/snat_rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID。 最小长度:1 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
admin_state_up |
否 |
Boolean |
解冻/冻结状态。 取值范围: "true":解冻 "false":冻结 |
cidr |
否 |
String |
可以是网段或者主机格式,与network_id参数二选一。 Source_type=0时,cidr必须是vpc子网网段的子集(不能相等); Source_type=1时,cidr必须指定专线侧网段。 |
limit |
否 |
Integer |
功能说明:每页返回的个数。 取值范围:0~2000。 默认值:2000。 最小值:1 最大值:2000 缺省值:2000 |
floating_ip_address |
否 |
Array |
功能说明:弹性公网IP。 数组长度:1 - 20 |
floating_ip_id |
否 |
Array |
功能说明:弹性公网IP的id。 数组长度:1 - 20 |
id |
否 |
String |
SNAT规则的ID。 最小长度:1 最大长度:36 |
description |
否 |
String |
SNAT规则的描述,长度范围小于等于255个字符,不能包含“<”和“>”。 最小长度:0 最大长度:255 |
created_at |
否 |
String |
SNAT规则的创建时间,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。 最小长度:1 最大长度:36 |
nat_gateway_id |
否 |
Array |
公网NAT网关实例的ID。 数组长度:1 - 10 |
network_id |
否 |
String |
规则使用的网络id。与cidr参数二选一。 最小长度:36 最大长度:36 |
source_type |
否 |
Integer |
0:VPC侧,可以指定network_id 或者cidr 1:专线侧,只能指定cidr 不输入默认为0(VPC) 最小值:0 最大值:1 缺省值:0 |
status |
否 |
String |
SNAT规则的状态。 取值为: "ACTIVE": 可用 "PENDING_CREATE":创建中 "PENDING_UPDATE":更新中 "PENDING_DELETE":删除中 "EIP_FREEZED":EIP冻结 "INACTIVE":不可用 枚举值:
|
marker |
否 |
String |
分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。
最小值:36 最大值:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:1 最大长度:10240 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
snat_rules |
Array of NatGatewaySnatRuleResponseBody objects |
查询SNAT规则列表的响应体。 数组长度:2000 - 0 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
SNAT规则的ID。 最小长度:36 最大长度:36 |
tenant_id |
String |
项目的ID。 最小长度:1 最大长度:36 |
nat_gateway_id |
String |
公网NAT网关实例的ID。 最小长度:36 最大长度:36 |
cidr |
String |
cidr,可以是网段或者主机格式,与network_id参数二选一。 Source_type=0时,cidr必须是vpc 子网网段的子集(不能相等); Source_type=1时,cidr必须指定专线侧网段。 最小长度:9 最大长度:18 |
source_type |
Integer |
0:VPC侧,可以指定network_id 或者cidr 1:专线侧,只能指定cidr 不输入默认为0(VPC) 最小值:0 最大值:1 缺省值:0 |
floating_ip_id |
String |
功能说明:弹性公网IP的id,多个弹性公网IP使用逗号分隔。 |
description |
String |
SNAT规则的描述,长度范围小于等于255个字符,不能包含“<”和“>”。 最小长度:0 最大长度:255 |
status |
String |
SNAT规则的状态。 取值为: "ACTIVE": 可用 "PENDING_CREATE":创建中 "PENDING_UPDATE":更新中 "PENDING_DELETE":删除中 "EIP_FREEZED":EIP冻结 "INACTIVE":不可用 枚举值:
|
created_at |
String |
SNAT规则的创建时间,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。 最小长度:1 最大长度:36 |
network_id |
String |
规则使用的网络id。与cidr参数二选一。 最小长度:36 最大长度:36 |
admin_state_up |
Boolean |
解冻/冻结状态。 取值范围:
|
floating_ip_address |
String |
功能说明:弹性公网IP,多个弹性公网IP使用逗号分隔。 |
freezed_ip_address |
String |
功能说明:冻结的弹性公网IP,多个冻结的弹性公网IP使用逗号分隔。 |
global_eip_id |
String |
全域弹性公网IP的id。 |
global_eip_address |
String |
全域弹性公网IP的地址。 |
请求示例
GET https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/snat_rules?limit=2
响应示例
状态码: 200
查询SNAT规则列表成功。
{ "snat_rules" : [ { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "network_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "source_type" : 0, "tenant_id" : "d199ba7e0ba64899b2e81518104b1526", "created_at" : "2017-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089b2502ff", "floating_ip_address" : "5.21.11.242", "freezed_ip_address" : "", "description" : "my snat rule 01" }, { "floating_ip_id" : "6e496fba-abe9-4f5e-9406-2ad8c809ac8c", "status" : "ACTIVE", "nat_gateway_id" : "e824f1b4-4290-4ebc-8322-cfff370dbd1e", "admin_state_up" : true, "network_id" : "97e89905-f9c8-4ae3-9856-392b0b2fbe7f", "source_type" : 0, "tenant_id" : "d199ba7e0ba64899b2e81518104b1526", "created_at" : "2017-11-17 07:43:44.830845", "id" : "4a1a10d7-0d9f-4846-8cda-24cffeffef5c", "floating_ip_address" : "5.21.11.142,5.21.11.143", "freezed_ip_address" : "5.21.11.142", "description" : "my snat rule 01" } ] }
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 59 60 |
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 ListNatGatewaySnatRulesSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); NatClient client = NatClient.newBuilder() .withCredential(auth) .withRegion(NatRegion.valueOf("<YOUR REGION>")) .build(); ListNatGatewaySnatRulesRequest request = new ListNatGatewaySnatRulesRequest(); request.withAdminStateUp(<admin_state_up>); request.withCidr("<cidr>"); request.withLimit(<limit>); request.withFloatingIpAddress(); request.withFloatingIpId(); request.withId("<id>"); request.withDescription("<description>"); request.withCreatedAt("<created_at>"); request.withNatGatewayId(); request.withNetworkId("<network_id>"); request.withSourceType(<source_type>); request.withStatus(ListNatGatewaySnatRulesRequest.StatusEnum.fromValue("<status>")); request.withMarker("<marker>"); try { ListNatGatewaySnatRulesResponse response = client.listNatGatewaySnatRules(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 40 41 42 |
# 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") credentials = BasicCredentials(ak, sk) \ client = NatClient.new_builder() \ .with_credentials(credentials) \ .with_region(NatRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListNatGatewaySnatRulesRequest() request.admin_state_up = <AdminStateUp> request.cidr = "<cidr>" request.limit = <limit> request.floating_ip_address = request.floating_ip_id = request.id = "<id>" request.description = "<description>" request.created_at = "<created_at>" request.nat_gateway_id = request.network_id = "<network_id>" request.source_type = <source_type> request.status = "<status>" request.marker = "<marker>" response = client.list_nat_gateway_snat_rules(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 44 45 46 47 48 49 50 51 52 53 54 55 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := nat.NewNatClient( nat.NatClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListNatGatewaySnatRulesRequest{} adminStateUpRequest:= <admin_state_up> request.AdminStateUp = &adminStateUpRequest cidrRequest:= "<cidr>" request.Cidr = &cidrRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest idRequest:= "<id>" request.Id = &idRequest descriptionRequest:= "<description>" request.Description = &descriptionRequest createdAtRequest:= "<created_at>" request.CreatedAt = &createdAtRequest networkIdRequest:= "<network_id>" request.NetworkId = &networkIdRequest sourceTypeRequest:= int32(<source_type>) request.SourceType = &sourceTypeRequest statusRequest:= model.GetListNatGatewaySnatRulesRequestStatusEnum().<STATUS> request.Status = &statusRequest markerRequest:= "<marker>" request.Marker = &markerRequest response, err := client.ListNatGatewaySnatRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询SNAT规则列表成功。 |
错误码
请参见错误码。