获取路由条目列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取路由条目列表

最近更新时间：2024.07.18 11:03:31首次发布时间：2023.02.08 11:43:01

本接口用于获取一个路由表中的路由条目的列表。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListRouteEntries`	接口名称。当前 API 的名称为 `ListRouteEntries`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。
route_table_identity	String	是	`route-table-7fs74n****`	路由表 ID。您可以通过 ListRouteTables 接口获取路由表 ID。
route_entry_type_list	[]String	是	`custom`	路由条目类型。取值范围： system：系统路由。 custom：自定义路由。
route_entry_next_hop_list	[]String	否	`172...3,172...2`	路由条目的下一跳列表。下一跳之间用半角逗号（,）分隔。如果不指定该参数，系统将查询所有相关的路由条目。
page	Integer	否	`1`	路由条目列表的页码。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
limit	Integer	否	`10`	分页查询时设置的每页行数。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
order_by	Integer	否	`1`	查询出来的路由条目的排列顺序，按照创建时间排序。取值范围： 1（默认值）：按照降序排列。 2：按照升序排列。

返回参数

参数	类型	示例值	描述
route_entry_instances	[]RouteEntryInstances	`请参见返回示例`	路由条目列表。
count	Long	`1`	路由条目个数。

RouteEntryInstances

参数	类型	示例值	描述
route_identity	String	`route-entry-nzpp5c****`	路由条目的 ID。
type	String	`custom`	路由条目的类型： system：系统路由条目。 custom：自定义路由条目。
dest_cidr	String	`114...0/16`	目标地址，须使用CIDR表示法。
next_hop_type	String	`veen`	下一跳类型： veen：边缘实例。 vpc_vgw：边缘云网关。 havip：高可用虚拟 IP。 natgw：NAT 网关。
next_hop	String	`172...3`	下一跳。
desc	String	`test_desc`	路由条目的描述。
is_enable	Boolean	`true`	该路由条目是否已启用： true：已启用。 false：未启用。
next_hop_instance_id	String	`veen2213161200001245****`	下一跳实例 ID。
route_table_identity	String	`route-table-wrqtcg****`	路由表的 ID。
create_time	Long	`1675739325`	创建时间。
update_time	Long	`1675062289`	更新时间。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListRouteEntries&Version=2021-04-30
&route_table_identity=route-table-29gwx9****
&route_entry_type_list=system
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202404011939273FD0650EACDF5D8B****",
        "Action": "ListRouteEntries",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "route_entry_instances": [
            {
                "account_identity": 210006****,
                "user_identity": 0,
                "route_identity": "",
                "type": "system",
                "dest_cidr": "10.**.**.0/24",
                "next_hop_type": "LOCAL",
                "next_hop": "LOCAL",
                "desc": "VPC子网系统路由",
                "is_enable": true,
                "next_hop_instance_id": "",
                "route_table_identity": "route-table-wrqtcg****",
                "create_time": 1711971568,
                "update_time": 1711971568
            },
            {
                "account_identity": 210006****,
                "user_identity": 0,
                "route_identity": "",
                "type": "system",
                "dest_cidr": "10.**.**.0/24",
                "next_hop_type": "LOCAL",
                "next_hop": "LOCAL",
                "desc": "VPC子网系统路由",
                "is_enable": true,
                "next_hop_instance_id": "",
                "route_table_identity": "route-table-wrqtcg****",
                "create_time": 1711971568,
                "update_time": 1711971568
            }
        ],
        "count": 2
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。