获取DNAT规则列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取DNAT规则列表

最近更新时间：2024.12.31 16:28:28首次发布时间：2024.12.31 16:28:28

本接口用于获取 DNAT 规则列表。

请求说明

请求方式：GET
请求地址：https://veenedge.volcengineapi.com/?Action=ListDNatRules&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListDNatRules	公共参数。该参数表示接口名称。取值：ListDNatRules。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
natgw_identity	String	是	natgw-bhhc****	DNAT 规则关联的 NAT 网关的 ID。您可以调用 ListNatGateways 接口查询 NAT 网关的 ID。
page	Integer	否	1	DNAT 规则列表的页码。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页指定行数的数据；如果仅指定 page，不指定 limit，将返回指定页的数据；如果 page 和 limit 都指定，将返回符合条件的数据。
limit	Integer	否	10	分页查询时设置的每页行数。默认值：10。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页指定行数的数据；如果仅指定 page，不指定 limit，将返回指定页的数据；如果 page 和 limit 都指定，将返回符合条件的数据。
order_by	Integer	否	1	查询出来的 DNAT 规则的排列顺序。取值范围： 1（默认值）：按照降序排列。 2：按照增序排列。
order_by_field	String	否	create_at	查询出来的 DNAT 规则的排序依据。取值范围： create_at（默认值）：按照创建时间排序。 update_at：按照更新时间排序。
fuzzy_id	String	否	dnatrule-758q5****	DNAT 规则的 ID。支持模糊查询。
fuzzy_name	String	否	test01	DNAT 规则的名称。支持模糊查询。
fuzzy_eip_addr	String	否	42...179	DNAT 规则关联的弹性公网 IP 地址。支持模糊查询。
fuzzy_private_ip	String	否	10...2	弹性公网 IP 对应的私网 IP 地址。支持模糊查询。
public_port_list	String	否	22	公网端口列表。公网端口之间用半角逗号（,）分隔。
private_port_list	String	否	22	私网端口列表。私网端口之间用半角逗号（,）分隔。
protocol_list	String	否	tcp	协议列表。协议之间用半角逗号（,）分隔。取值范围： tcp：TCP 协议。 udp：UDP 协议。 any：任意协议。仅开通相关权限的用户可使用该功能。
status_list	String	否	running	状态列表。状态之间用半角逗号（,）分隔。取值范围： creating：创建中。 running：运行中。 updating：更新中。 deleting：删除中。

返回参数

参数	类型	示例值	描述
rules	[]DnatRule	请参见返回示例	DNAT 规则的列表。
total_count	Integer	2	DNAT 规则的数量。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListDNatRules&Version=2021-04-30&natgw_identity=natgw-bhhc****
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241231114943CBF2730F330C095D****",
        "Action": "ListDNatRules",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "rules": [
            {
                "natgw_identity": "natgw-s9mqj5vzj8****",
                "dnat_rule_identity": "dnatrule-k2fvtqb****",
                "dnat_rule_name": "test-1",
                "status": "running",
                "port_config": "exact",
                "protocol": "tcp",
                "eip": {
                    "eip_identity": "eip-j8lf9c****",
                    "eip_addr": "42.**.**.181"
                },
                "private_ip": "10.**.**.2",
                "public_port": 22,
                "private_port": 22,
                "create_time": 1735615207,
                "update_time": 1735615207
            }
        ],
        "total_count": 1
    }
}