文档中心

NAT网关

DNAT规则

DescribeDnatEntries - 查询DNAT规则

调用 DescribeDnatEntries 接口，查询满足指定条件的DNAT规则。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的DNAT规则，若没有符合条件的DNAT规则，则返回空值。

若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有DNAT规则。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeDnatEntries

要执行的操作，取值：DescribeDnatEntries。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

ExternalPort string 可选示例值：34

接收来自外部请求的端口或端口段。

ExternalIp string 可选示例值：12.XX.XX.34

NAT网关用于网络地址转换的IP地址。

当NAT网关为公网NAT网关时，传入其绑定的公网IP地址。

当NAT网关为私网NAT网关时，传入其中转IP地址。

DnatEntryName string 可选示例值：dnat-01

DNAT规则的名称。

PageSize integer 可选示例值：20

每页的行数，最大值为100，默认值为20。

PageNumber integer 可选示例值：1

列表的页码，默认值为1。

InternalIp string 可选示例值：192.XX.XX.88

云服务器实例的私网IP。

Protocol string 可选示例值：tcp

协议类型。

tcp：转发TCP协议的报文。

udp：转发UDP协议的报文。

InternalPort string 可选示例值：12

云服务器实例私网IP的端口或端口段。

PortType string 可选示例值：specified

DNAT规则的端口类型。

specified：指定端口。

any：任意端口。即DNAT IP映射。

NatGatewayId string 可选示例值：ngw-2feq5xhimd88w59gp686****

NAT网关的ID。

DnatEntryIds.N string[] 可选示例值：dnat-342abc3bc3****

DNAT规则的ID。

参数 - N：表示DNAT规则ID的序号，单次调用数量上限20个ID。

多个ID之间请使用&分隔。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

DnatEntries object[] 示例值：-

DNAT的详细信息。

NatGatewayId string 示例值：ngw-2feq5xhimd88w59gp686****

DNAT规则所属NAT网关的ID。

DnatEntryId string 示例值：dnat-342abc3bc3****

DNAT规则的ID。

DnatEntryName string 示例值：dnat-01

DNAT规则的名称。

Protocol string 示例值：tcp

协议类型。

tcp：转发TCP协议的报文。

udp：转发UDP协议的报文。

Status string 示例值：Available

DNAT规则的状态。

Creating：创建中。

Deleting：删除中。

Available：可用。

InternalIp string 示例值：192.XX.XX.88

云服务器实例的私网IP。

InternalPort string 示例值：12

云服务器实例私网IP的端口或端口段。

ExternalIp string 示例值：12.XX.XX.34

NAT网关用于网络地址转换的IP地址。

ExternalPort string 示例值：34

接收来自外部请求的端口或端口段。

PortType string 示例值：specified

DNAT规则的端口类型。

PageSize integer 示例值：20

当前分页的行数。

PageNumber integer 示例值：1

当前分页的页码。

TotalCount integer 示例值：33

符合条件的DNAT规则总数。

RequestId string 示例值：2021062415303301022514515207C4****

请求ID。

请求示例

GET /?Action=DescribeDnatEntries&Version=2020-04-01&NatGatewayId=ngw-2feq5xhimd88w59gp686****&DnatEntryIds.1=dnat-342abc3bc3**** HTTP/1.1​
Host: natgateway.cn-beijing.volcengineapi.com​
ServiceName: natgateway​
Region: cn-beijing​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2021062415303301022514515207C4****",​
        "Action": "DescribeDnatEntries",​
        "Version": "2020-04-01",​
        "Service": "natgateway",​
        "Region": "cn-beijing"​
    },​
    "Result":{​
        "RequestId": "2021062415303301022514515207C4****",​
        "TotalCount": 1,​
        "PageNumber": 1,​
        "PageSize": 20,​
        "DnatEntries": [​
            {​
                "NatGatewayId": "ngw-2feq5xhimd88w59gp686****",​
                "DnatEntryId": "dnat-342abc3bc3****",​
                "DnatEntryName": "dnat-01",​
                "Protocol": "tcp",​
                "InternalIp": "192.XX.XX.88",​
                "InternalPort": "12",​
                "ExternalIp": "12.XX.XX.34",​
                "ExternalPort": "34",​
                "Status": "Available"​
            }​
        ]   ​
    }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.DnatEntryId	You've reached the limit on the number of DNAT entry IDs that you can describe.	已达到可查询的DNAT规则ID数量上限。
500	InternalError	An internal error has occurred.	发生内部错误。

最近更新时间：2026.03.27 17:44:42

这个页面对您有帮助吗？

有用

无用