# 查询DNAT规则列表 - ListNatGatewayDnatRules #### 功能介绍 查询DNAT规则列表。 #### 接口约束 可以在URI后面用'?'和'\&'添加不同的查询条件组合，支持参数说明中所有非必选参数过滤，请参考请求样例。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-natgateway/nat_api_0053.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-natgateway/nat_api_0063.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | nat:dnatRules:list | List | dnatRule \* | g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/dnat_rules 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目的ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | admin_state_up | 否 | Boolean | 解冻/冻结状态。 取值范围： - true：解冻 - false：冻结 | | external_service_port | 否 | Integer | Floatingip对外提供服务的端口号。 取值范围：0\~65535。 | | floating_ip_address | 否 | String | 弹性公网的IP地址。 | | global_eip_address | 否 | String | 全域弹性公网的IP地址。 | | status | 否 | Array of strings | DNAT规则的状态。 取值为: - ACTIVE: 可用 - PENDING_CREATE: 创建中 - PENDING_UPDATE: 更新中 - PENDING_DELETE: 删除中 - EIP_FREEZED: EIP冻结 - INACTIVE: 不可用 | | floating_ip_id | 否 | String | 弹性公网IP的id。 | | global_eip_id | 否 | String | 全域弹性公网IP的id。 | | internal_service_port | 否 | Integer | 虚拟机或者裸机对外提供服务的协议端口号。 取值范围：0\~65535。 | | limit | 否 | Integer | 功能说明：每页返回的个数。 取值范围：1\~2000。 默认值：2000。 | | id | 否 | String | DNAT规则的ID。 | | description | 否 | String | DNAT规则的描述，长度范围小于等于255个字符，不能包含"\<"和"\>"。 | | created_at | 否 | String | DNAT规则的创建时间，格式是yyyy-mm-dd hh:mm:ss.SSSSSS。 | | nat_gateway_id | 否 | Array of strings | 公网NAT网关实例的ID。 | | port_id | 否 | String | 虚拟机或者裸机的Port ID，对应虚拟私有云场景，与private_ip参数二选一。 | | private_ip | 否 | String | 用户私有IP地址，对应专线、云连接场景，与port_id参数二选一。 | | protocol | 否 | Array of strings | 协议类型，目前支持TCP/tcp、UDP/udp、ANY/any。 对应协议号6、17、0。 | | marker | 否 | String | 分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 - 若不传入marker和limit参数，查询结果返回第一页全部资源记录（默认2000条）。 - 若不传入marker参数，limit为10，查询结果返回第1\~10条资源记录。 - 若marker为第10条记录的资源ID，limit为10，查询结果返回第11\~20条资源记录。 - 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11条及之后的资源记录（默认2000条）。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dnat_rules | Array of [NatGatewayDnatRuleResponseBody] objects | 查询DNAT规则列表的响应体。 | 表5NatGatewayDnatRuleResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | DNAT规则的ID。 | | tenant_id | String | 项目的ID。 | | description | String | DNAT规则的描述。长度范围小于等于255个字符，不能包含"\<"和"\>"。 | | port_id | String | 虚拟机或者裸机的Port ID，对应虚拟私有云场景，与private_ip参数二选一。 | | private_ip | String | 用户私有IP地址，对应专线、云连接场景，与port_id参数二选一。 | | internal_service_port | Integer | 虚拟机或者裸机对外提供服务的协议端口号。 取值范围: 0\~65535。 | | nat_gateway_id | String | 公网NAT网关实例的ID。 | | global_eip_id | String | 全域弹性公网IP的id，与弹性公网IP的id二选一。 | | global_eip_address | String | 全域弹性公网IP的IP地址。 | | floating_ip_id | String | 弹性公网IP的id。 | | floating_ip_address | String | 弹性公网IP的IP地址。 | | external_service_port | Integer | Floatingip对外提供服务的端口号。 取值范围: 0\~65535。 | | status | String | DNAT规则的状态。 取值为: - ACTIVE: 可用 - PENDING_CREATE: 创建中 - PENDING_UPDATE: 更新中 - PENDING_DELETE: 删除中 - EIP_FREEZED: EIP冻结 - INACTIVE: 不可用 | | admin_state_up | Boolean | 解冻/冻结状态。 取值范围： - true：解冻 - false：冻结 | | internal_service_port_range | String | 虚拟机或者裸机对外提供服务的协议端口号范围。 功能说明: 该端口范围与external_service_port_range按顺序实现1:1映射。 取值范围: 1\~65535。 约束: 只能以'-'字符连接端口范围。 | | external_service_port_range | String | Floatingip对外提供服务的端口号范围。 功能说明: 该端口范围与internal_service_port_range按顺序实现1:1映射。 取值范围: 1\~65535。 约束: 只能以'-'字符连接端口范围 | | protocol | String | 协议类型，目前支持TCP/tcp、UDP/udp、ANY/any。 对应协议号6、17、0。 | | created_at | String | DNAT规则的创建时间，格式是yyyy-mm-dd hh:mm:ss.SSSSSS。 | #### 请求示例 ``` GET https://{NAT_endpoint}/v2/d199ba7e0ba64899b2e81518104b1526d/dnat_rules?limit=2 ``` #### 响应示例 **状态码：200** 查询DNAT规则列表成功。 ``` { "dnat_rules" : [ { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "private_ip" : "", "internal_service_port" : 993, "protocol" : "tcp", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526d", "created_at" : "2017-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089b2502ff", "floating_ip_address" : "5.21.11.226", "external_service_port" : 242, "description" : "my dnat rule 01" }, { "floating_ip_id" : "cf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "dda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "", "private_ip" : "192.168.1.100", "internal_service_port" : 0, "protocol" : "any", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526d", "created_at" : "2017-11-16T15:44:42Z", "id" : "89195d50-0271-41f1-bded-4c089b2502ff", "floating_ip_address" : "5.21.11.227", "external_service_port" : 0, "description" : "my dnat rule 01" } ] } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` 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 ListNatGatewayDnatRulesSolution { 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("")) .build(); ListNatGatewayDnatRulesRequest request = new ListNatGatewayDnatRulesRequest(); try { ListNatGatewayDnatRulesResponse response = client.listNatGatewayDnatRules(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()); } } } ``` #### Python ``` # 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("")) \ .build() try: request = ListNatGatewayDnatRulesRequest() response = client.list_nat_gateway_dnat_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) ``` #### Go ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := nat.NatClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := nat.NewNatClient(hcClient) request := &model.ListNatGatewayDnatRulesRequest{} response, err := client.ListNatGatewayDnatRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/NAT/sdk?api=ListNatGatewayDnatRules)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询DNAT规则列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-natgateway/ErrorCode.html)。