功能介紹
查詢路由表列表。
接口約束
-
支持分頁查詢, 支持過濾查詢: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
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID |
|
er_id |
是 |
String |
企業(yè)路由器 實例ID |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每頁返回的個數(shù)。 取值范圍:0~2000。 最小值:0 最大值:2000 |
|
marker |
否 |
String |
查詢的頁碼id,為空時為查詢第一頁。 使用說明:必須與limit一起使用。 最小長度:1 最大長度:128 |
|
state |
否 |
Array |
狀態(tài) |
|
is_default_propagation_table |
否 |
Boolean |
是否為默認傳播路由表 |
|
is_default_association_table |
否 |
Boolean |
是否為默認關聯(lián)路由表 |
|
sort_key |
否 |
Array |
按關鍵字排序,默認按照id排序,可選值:id|name|state |
|
sort_dir |
否 |
Array |
返回結果按照升序或降序排列,默認為asc,降序為desc |
請求參數(shù)
無
響應參數(shù)
狀態(tài)碼: 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
route_tables |
路由表列表 |
|
|
request_id |
String |
請求ID |
|
page_info |
分頁查詢的信息 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
路由表的id |
|
name |
String |
路由表名字 |
|
description |
String |
描述信息 |
|
is_default_association |
Boolean |
是否為默認關聯(lián)的路由表 缺省值:false |
|
is_default_propagation |
Boolean |
是否為默認傳遞路由表 |
|
state |
String |
路由表狀態(tài),支持的狀態(tài)有pending | available | deleting | deleted | failed |
|
tags |
標簽 |
|
|
created_at |
String |
創(chuàng)建時間 |
|
updated_at |
String |
更新時間 |
請求示例
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/
915a14a6-867b-4af7-83d1-70efceb146f5/route-tables
響應示例
狀態(tài)碼: 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"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯誤碼
請參見錯誤碼。
