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

文档中心

立即注册

导航

边缘计算节点

获取SNAT规则列表

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

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListSNatRules	公共参数。该参数表示接口名称。取值：ListSNatRules。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
natgw_identity	String	是	natgw-bhhc****	SNAT 规则关联的 NAT 网关的 ID。您可以调用 ListNatGateways 接口查询 NAT 网关的 ID。
page	Integer	否	1	SNAT 规则列表的页码。如果 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	查询出来的 SNAT 规则的排列顺序。取值范围： 1（默认值）：按照降序排列。 2：按照增序排列。
order_by_field	String	否	create_at	查询出来的 SNAT 规则的排序依据。取值范围： create_at（默认值）：按照创建时间排序。 update_at：按照更新时间排序。

返回参数

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

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202412311027402ADA7D190FE08AA7****",
        "Action": "ListSNatRules",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "rules": [
            {
                "natgw_identity": "natgw-s9mqj5vzj8d****",
                "snat_rule_identity": "snatrule-rb2mrpp2fp9****",
                "snat_rule_name": "test01",
                "status": "running",
                "backend_type": "custom",
                "custom_cidr": "10.**.**.0/24",
                "eip_list": [
                    {
                        "eip_identity": "eip-9gr7f4****",
                        "eip_addr": "42.**.**.183"
                    }
                ],
                "reveal_src_ip": false,
                "create_time": 1735611770,
                "update_time": 1735611902
            }
        ],
        "total_count": 1
    }
}