功能介绍
查询静态路由列表。
接口约束
-
支持分页查询，支持过滤查询：destination，attachment_id, resource_type, type。
-
支持单字段排序，排序字段有[id,destination,created_at,updated_at]，不支持多字段排序。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v3/{project_id}/ent erp rise-router/route-tables/{route_table_id}/static-routes
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
route_table_id |
是 |
String |
路由表ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每页返回的个数。 取值范围：0~2000。 最小值：0 最大值：2000 |
|
marker |
否 |
String |
查询的页码id，为空时为查询第一页。 使用说明：必须与limit一起使用。 最小长度：1 最大长度：128 |
|
destination |
否 |
Array |
路由目的地址 |
|
attachment_id |
否 |
Array |
连接ID |
|
resource_type |
否 |
Array |
|
|
sort_key |
否 |
Array |
按关键字排序，默认按照id排序，可选值:id|name|state |
|
sort_dir |
否 |
Array |
返回结果按照升序或降序排列，默认为asc,降序为desc |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
routes |
路由列表 |
|
|
request_id |
String |
请求ID |
|
page_info |
分页查询的信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
路由id |
|
type |
String |
路由类型 |
|
state |
String |
路由状态 |
|
is_blackhole |
Boolean |
是否为黑洞路由 |
|
destination |
String |
路由目的地址 |
|
attachments |
下一跳列表 |
|
|
route_table_id |
String |
路由表id |
|
created_at |
String |
创建时间 |
|
updated_at |
String |
更新时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
连接关联的资源ID |
|
resource_type |
String |
连接关联的资源类型:
|
|
attachment_id |
String |
连接ID |
请求示例
查询静态路由列表
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/
route-tables/915a14a6-867b-4af7-83d1-70efceb146f5/static-routes
响应示例
状态码： 200
OK
{
"routes" : [ {
"id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
"type" : "static",
"destination" : "192.168.0.0/16",
"attachments" : [ {
"resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
"resource_type" : "vpc",
"attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289"
} ],
"route_table_id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
"state" : "pending",
"created_at" : "2020-03-11T15:13:31Z",
"updated_at" : "2020-03-11T15:13:31Z"
} ],
"page_info" : {
"next_marker" : "1",
"current_count" : 1
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
