You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /边缘计算节点/边缘计算节点/API 参考/路由表/获取路由表列表
获取路由表列表
最近更新时间：2024.07.18 11:03:31首次发布时间：2023.02.08 11:43:01
我的收藏

本接口用于获取路由表的列表。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListRouteTables接口名称。当前 API 的名称为 ListRouteTables。
VersionString是2021-04-30接口版本。当前 API 的版本为 2021-04-30。
route_table_list[]String是route-table-7fs74n****路由表 ID 列表。ID 之间用半角逗号（,）分隔。

status_list

[]String

是

updating,running

路由表状态列表。路由表状态之间用半角逗号（,）分隔。取值范围：

  • updating：变更中。
  • running：运行中。
    如果不指定该参数，系统将查询所有状态的路由表。

type_list

[]String

是

default

路由表类型列表。路由表类型之间用半角逗号（,）分隔。取值范围：

  • default：默认路由表。
  • custom：自定义路由表。
    如果不指定该参数，系统将查询所有类型的路由表。
fuzzy_route_table_idString否7fs74n路由表 ID。支持模糊查询。
fuzzy_route_table_nameString否7fs74n路由表名称。支持模糊查询。
fuzzy_vpc_idString否7fs74n私有网络 ID。支持模糊查询。
cluster_name_list[]String否zj**-test01节点列表。节点之间用半角逗号（,）分隔。

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_table_instances[]RouteTableInstances请参见返回示例路由表列表。
countLong1路由表个数。

RouteTableInstances

参数类型示例值描述
route_table_identityStringroute-table-7fs74n****路由表的 ID。
route_table_nameStringvpc-7fs74n****-默认路由表路由表的名称。

type

String

default

路由表的类型：

  • default：默认路由表。
  • custom：自定义路由表。

status

String

running

路由表的状态：

  • updating：变更中。
  • running：运行中。
vpc_identityStringvpc-7fs74n****路由表所属私有网络的 ID。
vpc_nameString****03-默认VPC路由表所属私有网络的名称。
descStringvpc-7fs74n****-默认路由表路由表的描述。
create_timeLong1675062289路由表的创建时间。
update_timeLong1675062289路由表的更新时间。
associated_subnet_countLong2路由表关联的子网的数量。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230522172457278922232F61C893****",
        "Action": "ListRouteTables",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "route_table_instances": [
            {
                "account_identity": 210000****,
                "user_identity": 0,
                "route_table_identity": "route-table-djxn57***",
                "route_table_name": "vpc-djxn57****-默认路由表",
                "type": "default",
                "status": "running",
                "vpc_identity": "vpc-djxn57****",
                "vpc_name": "**移动01-默认VPC",
                "desc": "vpc-djxn57****-默认路由表",
                "associated_subnet_count": 2,
                "create_time": 1682665425,
                "update_time": 1682665425
            }
        ],
        "count": 1
    }
}

错误码

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