呼叫DescribeVpnRouteEntries介面查詢VPN閘道執行個體的目的路由項目資訊和BGP路由項目資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vpc:DescribeVpnRouteEntries |
get |
*VpnGateway。
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
VPN 閘道執行個體所在的地域 ID。 您可以透過呼叫 DescribeRegions 介面取得地域 ID。 |
cn-hangzhou |
| VpnGatewayId |
string |
是 |
VPN 閘道的執行個體 ID。 |
vpn-bp1cmw7jh1nfe43m9**** |
| PageNumber |
integer |
否 |
清單的頁碼。預設值：1。 |
1 |
| PageSize |
integer |
否 |
分頁查詢時每頁的列數。最大值：50。預設值：10。 |
10 |
| RouteEntryType |
string |
否 |
路由項目的類型。取值：
|
custom |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
傳回結果。 |
||
| PageNumber |
integer |
清單的頁碼。 |
1 |
| PageSize |
integer |
分頁查詢時每頁的列數。 |
10 |
| RequestId |
string |
請求 ID。 |
BF3995A6-FA4F-4C74-B90F-89ECF4BFF4D5 |
| TotalCount |
integer |
清單總項目數。 |
1 |
| VpnRouteCounts |
object |
||
| VpnRouteCount |
array<object> |
雙隧道模式 VPN 閘道執行個體的路由項目統計資訊。 說明
僅支援雙隧道模式 IPsec-VPN 連線的 VPN 閘道執行個體會傳回該組資訊。 |
|
|
object |
路由項目的統計資訊。 |
||
| RouteCount |
integer |
路由項目數量。 |
3 |
| RouteEntryType |
string |
路由項目類型。
|
bgp |
| Source |
string |
BGP 路由項目的來源。
|
VPN_BGP |
| VpnRouteEntries |
object |
||
| VpnRouteEntry |
array<object> |
路由項目資訊清單。 |
|
|
object |
路由項目詳細資訊。 |
||
| AsPath |
string |
路由項目經過的 AS 路徑。 |
65501,65001,60011 |
| Community |
string |
路由項目的 Community 屬性值。 |
65001:1000,65501:2000 |
| CreateTime |
integer |
建立路由項目的時間戳記。 時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立路由項目時的總時長。 |
1563874074000 |
| NextHop |
string |
路由項目的下一跳。 |
vco-bp1tui07ob10fmuro**** |
| NextHopTunnelId |
string |
路由項目下一跳關聯的隧道 ID。 說明
僅支援雙隧道模式 IPsec-VPN 連線的 VPN 閘道執行個體會傳回目前參數。 |
tun-36cfgpwjn58axj**** |
| PrefixListId |
string |
首碼清單的執行個體 ID。 |
pl-m5estsqsdqwg88hjf**** |
| RouteDest |
string |
路由項目的目標網段。 |
10.0.0.0/24 |
| RouteEntryType |
string |
路由項目的類型。
|
custom |
| Source |
string |
BGP 路由項目的來源。
|
CLOUD |
| State |
string |
路由項目的狀態。取值：
|
normal |
| VpnInstanceId |
string |
VPN 閘道執行個體 ID。 |
vpn-bp1cmw7jh1nfe43m9**** |
| Weight |
integer |
目的路由的權重值。
|
100 |
樣本
正常返回樣本
JSON格式
{
"PageNumber": 1,
"PageSize": 10,
"RequestId": "BF3995A6-FA4F-4C74-B90F-89ECF4BFF4D5",
"TotalCount": 1,
"VpnRouteCounts": {
"VpnRouteCount": [
{
"RouteCount": 3,
"RouteEntryType": "bgp",
"Source": "VPN_BGP"
}
]
},
"VpnRouteEntries": {
"VpnRouteEntry": [
{
"AsPath": "65501,65001,60011",
"Community": "65001:1000,65501:2000",
"CreateTime": 1563874074000,
"NextHop": "vco-bp1tui07ob10fmuro****",
"NextHopTunnelId": "tun-36cfgpwjn58axj****",
"PrefixListId": "pl-m5estsqsdqwg88hjf****",
"RouteDest": "10.0.0.0/24",
"RouteEntryType": "custom",
"Source": "CLOUD",
"State": "normal",
"VpnInstanceId": "vpn-bp1cmw7jh1nfe43m9****",
"Weight": 100
}
]
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | IllegalParam.RouteEntryType | The specified "RouteEntryType" is invalid. | |
| 400 | InvalidVpnInstanceId.NotFound | The specified VPN was not found. | 指定的 VPN 執行個體未找到。 |
| 400 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | 指定的 VPN 閘道不存在，請您檢查 VPN 閘道是否正確。 |
| 403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您沒有權限操作指定資源，請申請權限後再操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。