华为云计算 云知识 查询路由表列表ListRouteTableser
查询路由表列表ListRouteTableser

 

功能介绍

查询路由表列表。

接口约束

  • 支持分页查询, 支持过滤查询:state, is_default_propagation_route_table, is_default_association_route_table。

  • 支持单字段排序,排序字段有[id,name,description,created_at,updated_at],不支持多字段排序。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v3/{project_id}/enterprise-router/{er_id}/route-tables

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

er_id

String

企业路由器 实例ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。 取值范围:0~2000。

最小值:0

最大值:2000

marker

String

查询的页码id,为空时为查询第一页。 使用说明:必须与limit一起使用。

最小长度:1

最大长度:128

state

Array

状态

is_default_propagation_table

Boolean

是否为默认传播路由表

is_default_association_table

Boolean

是否为默认关联路由表

sort_key

Array

按关键字排序,默认按照id排序,可选值:id|name|state

sort_dir

Array

返回结果按照升序或降序排列,默认为asc,降序为desc

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

route_tables

Array of RouteTable objects

路由表列表

request_id

String

请求ID

page_info

PageInfo object

分页查询的信息

表4 RouteTable

参数

参数类型

描述

id

String

路由表的id

name

String

路由表名字

description

String

描述信息

is_default_association

Boolean

是否为默认关联的路由表

缺省值:false

is_default_propagation

Boolean

是否为默认传递路由表

state

String

路由表状态,支持的状态有pending | available | deleting | deleted | failed

tags

Array of Tag objects

标签

created_at

String

创建时间

updated_at

String

更新时间

表5 Tag

参数

参数类型

描述

key

String

标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

最小长度:0

最大长度:128

value

String

标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。

最小长度:0

最大长度:128

表6 PageInfo

参数

参数类型

描述

next_marker

String

下一个marker标识,为空时表示最后一页

current_count

Integer

当前列表中资源数量

请求示例

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/
915a14a6-867b-4af7-83d1-70efceb146f5/route-tables

响应示例

状态码: 200

OK

{
  "route_tables" : [ {
    "id" : "4ab54142-7c92-48ad-8288-77727a231052",
    "is_default_association" : false,
    "is_default_propagation" : false,
    "name" : "my-router-table1",
    "description" : "rtb-for-a",
    "state" : "available",
    "tags" : [ {
      "key" : "key",
      "value" : "value"
    } ]
  }, {
    "id" : "4ab54142-7c92-48ad-8288-77727a231053",
    "is_default_association" : false,
    "is_default_propagation" : false,
    "name" : "my-router-table2",
    "description" : "rtb-for-b",
    "state" : "available",
    "tags" : [ {
      "key" : "key",
      "value" : "value"
    } ]
  } ],
  "page_info" : {
    "next_marker" : "1",
    "current_count" : 2
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

 

上一篇:华为云先锋少年论坛 下一篇:IT与OT融合 企业IT与OT集成