文档首页/ NAT网关 NAT/ API参考/ API(公网NAT网关)/ DNAT规则/ 查询指定的DNAT规则详情 - ShowNatGatewayDnatRule
更新时间:2026-05-22 GMT+08:00

查询指定的DNAT规则详情 - ShowNatGatewayDnatRule

功能介绍

查询指定的DNAT规则详情。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    nat:dnatRules:get

    Read

    gateway *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

    dnatRule *

    g:EnterpriseProjectId

URI

GET /v2/{project_id}/dnat_rules/{dnat_rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

dnat_rule_id

String

DNAT规则的ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

dnat_rule

NatGatewayDnatRuleResponseBody object

DNAT规则的响应体。

表4 NatGatewayDnatRuleResponseBody

参数

参数类型

描述

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/5b95c675-69c2-4656-ba06-58ff72e1d338

  

响应示例

状态码:200

查询DNAT规则成功。

{
  "dnat_rule" : {
    "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" : "5b95c675-69c2-4656-ba06-58ff72e1d338",
    "floating_ip_address" : "5.21.11.226",
    "external_service_port" : 242,
    "description" : "my dnat rule 01"
  }
}

SDK代码示例

SDK代码示例如下。

Java

 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
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 ShowNatGatewayDnatRuleSolution {

    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();
        ShowNatGatewayDnatRuleRequest request = new ShowNatGatewayDnatRuleRequest();
        request.withDnatRuleId("{dnat_rule_id}");
        try {
            ShowNatGatewayDnatRuleResponse response = client.showNatGatewayDnatRule(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

 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
# 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 = ShowNatGatewayDnatRuleRequest()
        request.dnat_rule_id = "{dnat_rule_id}"
        response = client.show_nat_gateway_dnat_rule(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

 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
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("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := nat.NewNatClient(hcClient)

    request := &model.ShowNatGatewayDnatRuleRequest{}
	request.DnatRuleId = "{dnat_rule_id}"
	response, err := client.ShowNatGatewayDnatRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询DNAT规则成功。

错误码

请参见错误码