功能介紹
查詢靜態(tài)路由列表。
接口約束
-
支持分頁(yè)查詢,支持過(guò)濾查詢:destination,attachment_id, resource_type, type。
-
支持單字段排序,排序字段有[id,destination,created_at,updated_at],不支持多字段排序。
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID |
|
route_table_id |
是 |
String |
路由表ID |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每頁(yè)返回的個(gè)數(shù)。 取值范圍:0~2000。 最小值:0 最大值:2000 |
|
marker |
否 |
String |
查詢的頁(yè)碼id,為空時(shí)為查詢第一頁(yè)。 使用說(shuō)明:必須與limit一起使用。 最小長(zhǎng)度:1 最大長(zhǎng)度:128 |
|
destination |
否 |
Array |
路由目的地址 |
|
attachment_id |
否 |
Array |
連接ID |
|
resource_type |
否 |
Array |
|
|
sort_key |
否 |
Array |
按關(guān)鍵字排序,默認(rèn)按照id排序,可選值:id|name|state |
|
sort_dir |
否 |
Array |
返回結(jié)果按照升序或降序排列,默認(rèn)為asc,降序?yàn)閐esc |
請(qǐng)求參數(shù)
無(wú)
響應(yīng)參數(shù)
狀態(tài)碼: 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
routes |
路由列表 |
|
|
request_id |
String |
請(qǐng)求ID |
|
page_info |
分頁(yè)查詢的信息 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
路由id |
|
type |
String |
路由類型 |
|
state |
String |
路由狀態(tài) |
|
is_blackhole |
Boolean |
是否為黑洞路由 |
|
destination |
String |
路由目的地址 |
|
attachments |
下一跳列表 |
|
|
route_table_id |
String |
路由表id |
|
created_at |
String |
創(chuàng)建時(shí)間 |
|
updated_at |
String |
更新時(shí)間 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
resource_id |
String |
連接關(guān)聯(lián)的資源ID |
|
resource_type |
String |
連接關(guān)聯(lián)的資源類型:
|
|
attachment_id |
String |
連接ID |
請(qǐng)求示例
查詢靜態(tài)路由列表
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/
route-tables/915a14a6-867b-4af7-83d1-70efceb146f5/static-routes
響應(yīng)示例
狀態(tài)碼: 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"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
