DescribeDnatEntries--NAT网关-火山引擎

文档中心

立即注册

导航

DescribeDnatEntries

最近更新时间：2024.07.09 08:36:55首次发布时间：2022.11.03 08:29:57

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

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的DNAT规则，若没有符合条件的DNAT规则，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有DNAT规则。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDnatEntries	要执行的操作，取值：DescribeDnatEntries。
Version	String	是	2020-04-01	API的版本信息，当前版本为：2020-04-01。
NatGatewayId	String	否	ngw-2feq5xhimd88w59gp686****	NAT网关的ID。您可以调用 DescribeNatGateways 接口，查询NAT网关的ID。
DnatEntryIds.N	String	否	DnatEntryIds.1=dnat-342abc3bc3**&DnatEntryIds.2=dnat-342abc3bc4**	DNAT规则的ID。参数 - N：表示SNAT规则ID的序号，单次调用数量上限20个ID。多个ID之间请使用&分隔。
DnatEntryName	String	否	dnat-01	DNAT规则的名称。
PortType	String	否	specified	DNAT规则的端口类型。 specified：指定端口。 any：任意端口。即DNAT IP映射。
Protocol	String	否	tcp	协议类型。 tcp：转发TCP协议的报文。 udp：转发UDP协议的报文。 any：转发所有协议的报文。
InternalIp	String	否	192.XX.XX.88	云服务器实例的私网IP。
InternalPort	String	否	12	云服务器实例私网IP的端口或端口段。
ExternalIp	String	否	12.XX.XX.34	NAT网关用于网络地址转换的IP地址。当NAT网关为公网NAT网关时，传入其绑定的公网IP地址。当NAT网关为私网NAT网关时，传入其中转IP地址。
ExternalPort	String	否	34	接收请求的端口或端口段。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	20	每页的行数，最大值为100，默认值为20。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
TotalCount	Integer	33	符合条件的DNAT规则总数。
PageNumber	Integer	1	当前分页的页码。
PageSize	Integer	20	当前分页的行数。
DnatEntries	Array of struct	-	DNAT的详细信息。具体请参见下表“DnatEntries结构”。

DnatEntries结构

参数名称	类型	示例值	描述
NatGatewayId	String	ngw-2feq5xhimd88w59gp686****	DNAT规则所属NAT网关的ID。
DnatEntryId	String	dnat-342abc3bc3****	DNAT规则的ID。
DnatEntryName	String	dnat-01	DNAT规则的名称。
PortType	String	specified	DNAT规则的端口类型。
Protocol	String	tcp	协议类型。
InternalIp	String	192.XX.XX.88	云服务器实例的私网IP。
InternalPort	String	12	云服务器实例私网IP的端口或端口段。
ExternalIp	String	12.XX.XX.34	NAT网关用于网络地址转换的IP地址。当NAT网关为公网NAT网关时，其为公网IP地址。当NAT网关为私网NAT网关时，其为中转IP地址。
ExternalPort	String	34	接收请求的端口或端口段。
Status	String	Available	DNAT规则的状态。 Creating：创建中。 Deleting：删除中。 Available：可用。

请求示例

GET /?Action=DescribeDnatEntries&Version=2020-04-01&NatGatewayId=ngw-2feq5xhimd88w59gp686****&ExternalIp=12.XX.XX.34  HTTP/1.1
Host: open.volcengineapi.com
Service: 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"
            }
        ]   
    }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
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数量上限。