全部產品
Search
文件中心

VPN Gateway:DescribeVpnPbrRouteEntries

更新時間:Aug 07, 2026

呼叫 DescribeVpnPbrRouteEntries 介面查詢 VPN 閘道器執行個體下設定的原則路由資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeVpnPbrRouteEntries

get

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

VPN 閘道器執行個體所在的地域 ID。

您可以透過呼叫 DescribeRegions 介面取得地域 ID。

eu-central-1

VpnGatewayId

string

VPN 閘道器執行個體 ID。

vpn-bp1a3kqjiiq9legfx****

PageNumber

integer

清單的頁碼。預設值:1

1

PageSize

integer

分頁查詢時每頁的項目數。最大值:50。預設值:10

10

返回參數

名稱

類型

描述

樣本值

object

返回結果。

PageSize

integer

分頁查詢時每頁的項目數。

10

RequestId

string

請求 ID。

5BE01CD7-5A50-472D-AC14-CA181C5C03BE

PageNumber

integer

清單的頁碼。

1

TotalCount

integer

清單項目數。

1

VpnPbrRouteEntries

object

VpnPbrRouteEntry

array<object>

原則路由資訊清單。

object

原則路由的資訊。

NextHop

string

原則路由的下一跳。

vco-bp15oes1py4i66rmd****

Weight

integer

原則路由的權重值。

對於支援 IPsec-VPN 連線單隧道模式的 VPN 閘道器執行個體,原則路由權重值代表原則路由的優先順序:

  • 100:表示高優先順序。存在來源網段、目標網段均相同的多條原則路由時,該原則路由關聯的 IPsec 連線為主鏈路。

  • 0:表示低優先順序。存在來源網段、目標網段均相同的多條原則路由時,該原則路由關聯的 IPsec 連線為備用鏈路。

說明

對於支援 IPsec-VPN 連線雙隧道模式的 VPN 閘道器執行個體,目前參數不生效。

100

RouteDest

string

原則路由的目標網段。

10.0.0.0/24

State

string

原則路由的發佈狀態。

  • published:已將原則路由發佈至 VPC 的路由表。

  • normal:未將原則路由發佈至 VPC 的路由表。

published

CreateTime

integer

建立原則路由的時間戳記。單位:毫秒。

時間戳記的格式採用 Unix 時間戳記,表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立原則路由時的總時長。

1492747187000

VpnInstanceId

string

VPN 閘道器執行個體 ID。

vpn-bp1a3kqjiiq9legfx****

RouteSource

string

原則路由的來源網段。

192.168.0.0/24

Priority

integer

原則路由的原則優先順序。

原則優先順序數字越小,原則路由的優先順序越高。

10

NextHopTunnelId

string

原則路由下一跳關聯的隧道 ID。

僅支援雙隧道模式 IPsec-VPN 連線的 VPN 閘道器執行個體會返回目前參數。

tun-opsqc4d97wni2****

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnPbrRouteEntries": {
    "VpnPbrRouteEntry": [
      {
        "NextHop": "vco-bp15oes1py4i66rmd****",
        "Weight": 100,
        "RouteDest": "10.0.0.0/24",
        "State": "published",
        "CreateTime": 1492747187000,
        "VpnInstanceId": "vpn-bp1a3kqjiiq9legfx****",
        "RouteSource": "192.168.0.0/24",
        "Priority": 10,
        "NextHopTunnelId": "tun-opsqc4d97wni2****"
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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. EIP 不屬於目前呼叫者,請您檢查該 EIP 是否可被您呼叫。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情