功能介紹
查詢提交請(qǐng)求的租戶有權(quán)限操作的所有路由器信息，單次查詢最多返回2000條數(shù)據(jù)，超過2000后會(huì)返回分頁標(biāo)記。分頁查詢請(qǐng)參考分頁查詢。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
GET /v2.0/routers
樣例：
GET https://{Endpoint}/v2.0/routers?id={id}&name={name}&admin_state_up={admin_state_up}&tenant_id={tenant_id}&status={status}
分頁查詢樣例：
GET https://{Endpoint}/v2.0/routers?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&page_reverse=False
|
名稱 |
是否必選 |
參數(shù)類型 |
說明 |
|---|---|---|---|
|
id |
否 |
String |
按照路由器的ID過濾查詢 |
|
admin_state_up |
否 |
Boolean |
按照路由器的管理狀態(tài)過濾查詢 取值范圍：true or false |
|
status |
否 |
String |
按照路由器的狀態(tài)過濾查詢 取值范圍：ACTIVE， DOWN，ERROR |
|
tenant_id |
否 |
String |
按照路由器所屬的項(xiàng)目ID過濾查詢 |
|
marker |
否 |
String |
分頁查詢的起始資源ID，表示從指定資源的下一條記錄開始查詢。 marker需要和limit配合使用：
|
|
limit |
否 |
Integer |
分頁查詢每頁返回的記錄個(gè)數(shù)，取值范圍為0~intmax（2^31-1），默認(rèn)值2000。 limit需要和marker配合使用，詳細(xì)規(guī)則請(qǐng)見marker的參數(shù)說明。 |
請(qǐng)求參數(shù)
無。
請(qǐng)求示例
GET https://{Endpoint}/v2.0/routers?limit=1
響應(yīng)參數(shù)
|
參數(shù)名稱 |
類型 |
說明 |
|---|---|---|
|
routers |
||
|
routers_links |
只有在使用limit過濾，并且資源個(gè)數(shù)超過limit或者資源個(gè)數(shù)超過2000時(shí)（limit默認(rèn)值），該參數(shù)的rel和href取值才會(huì)顯示為next和其對(duì)應(yīng)的link。 |
|
屬性 |
類型 |
說明 |
|---|---|---|
|
id |
String |
路由器的id 【使用說明】在查詢路由器列表時(shí)非必選 |
|
name |
String |
路由器的名稱。 僅支持?jǐn)?shù)字、字母、_(下劃線)、-（中劃線）、.（點(diǎn)）。 |
|
admin_state_up |
Boolean |
管理狀態(tài)。 只支持true。 |
|
status |
String |
狀態(tài)，可以為ACTIVE， DOWN，ERROR。 |
|
tenant_id |
String |
項(xiàng)目ID |
|
external_gateway_info |
擴(kuò)展屬性：外部網(wǎng)關(guān)信息，參見external_gateway_info對(duì)象 |
|
|
routes |
||
|
project_id |
String |
項(xiàng)目ID，請(qǐng)參見獲取項(xiàng)目ID。 |
|
created_at |
String |
資源創(chuàng)建時(shí)間，UTC時(shí)間 格式：yyyy-MM-ddTHH:mm:ss |
|
updated_at |
String |
資源更新時(shí)間，UTC時(shí)間 格式：yyyy-MM-ddTHH:mm:ss |
|
屬性 |
類型 |
說明 |
|---|---|---|
|
network_id |
String |
外部網(wǎng)絡(luò)的UUID。 外部網(wǎng)絡(luò)的信息請(qǐng)通過GET /v2.0/networks?router:external=True或neutron net-external-list方式查詢。 |
|
enable_snat |
Boolean |
是否啟用SNAT。 默認(rèn)為false。 |
響應(yīng)示例
{
"routers": [
{
"id": "01ab4be1-4447-45fb-94be-3ee787ed4ebe",
"name": "xiaoleizi-tag",
"status": "ACTIVE",
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"admin_state_up": true,
"external_gateway_info": {
"network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
"enable_snat": false
},
"routes": [
{
"destination": "0.0.0.0/0",
"nexthop": "172.16.0.124"
}
],
"created_at": "2018-03-23T09:26:08",
"updated_at": "2018-08-24T08:49:53"
}
],
"routers_links": [
{
"rel": "next",
"href": "https://{Endpoint}/v2.0/routers?limit=1&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe"
},
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/routers?limit=1&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&page_reverse=True"
}
]
}
狀態(tài)碼
請(qǐng)參見狀態(tài)碼。
錯(cuò)誤碼
請(qǐng)參見錯(cuò)誤碼。
