全部产品
Search

搜索本产品

    VPN网关：DescribeVpnPbrRouteEntries - 查询策略路由

    文档中心

    VPN网关：DescribeVpnPbrRouteEntries - 查询策略路由

    更新时间：Nov 27, 2024

    调用DescribeVpnPbrRouteEntries接口查询VPN网关实例下配置的策略路由的信息。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    vpc:DescribeVpnPbrRouteEntriesget
    *VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    VPN 网关实例所在的地域 ID。

    您可以通过调用 DescribeRegions 接口获取地域 ID。

    		eu-central-1
    VpnGatewayIdstring是

    VPN 网关实例 ID。

    		vpn-bp1a3kqjiiq9legfx****
    PageNumberinteger否

    列表的页码。默认值：1。

    		1
    PageSizeinteger否

    分页查询时每页的条目数。最大值：50。默认值：10。

    		10

    返回参数

    名称类型描述示例值
    object

    返回结果。

    PageSizeinteger

    分页查询时每页的条目数。

    		10
    RequestIdstring

    请求 ID。

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

    列表的页码。

    		1
    TotalCountinteger

    列表条目数。

    		1
    VpnPbrRouteEntriesarray<object>

    策略路由信息列表。

    VpnPbrRouteEntryobject

    策略路由的信息。

    NextHopstring

    策略路由的下一跳。

    		vco-bp15oes1py4i66rmd****
    Weightinteger

    策略路由的权重值。

    对于支持 IPsec-VPN 连接单隧道模式的 VPN 网关实例，策略路由权重值代表策略路由的优先级：

    • 100：表示高优先级。存在源网段、目标网段均相同的多条策略路由时，该策略路由关联的 IPsec 连接为主链路。
    • 0：表示低优先级。存在源网段、目标网段均相同的多条策略路由时，该策略路由关联的 IPsec 连接为备链路。
    说明 对于支持 IPsec-VPN 连接双隧道模式的 VPN 网关实例，当前参数不生效。
    		100
    RouteDeststring

    策略路由的目标网段。

    		10.0.0.0/24
    Statestring

    策略路由的发布状态。

    • published：已发布策略路由到 VPC 的路由表。

    • normal：未发布策略路由到 VPC 的路由表。

    		published
    CreateTimelong

    创建策略路由的时间戳。单位：毫秒。

    时间戳的格式采用 Unix 时间戳，表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至创建策略路由时的总时长。

    		1492747187000
    VpnInstanceIdstring

    VPN 网关实例 ID。

    		vpn-bp1a3kqjiiq9legfx****
    RouteSourcestring

    策略路由的源网段。

    		192.168.0.0/24
    Priorityinteger

    策略路由的策略优先级。

    策略优先级数字越小，策略路由的优先级越高。

    		10
    NextHopTunnelIdstring

    策略路由下一跳关联的隧道 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错误码错误信息描述
    400InvalidVpnInstanceId.NotFoundThe specified VPN was not found.指定的VPN实例未找到。
    400InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.指定的 VPN 网关不存在，请您检查 VPN 网关是否正确。
    403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.您没有权限操作该资源，请您申请操作权限后再试。
    403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源，请申请权限后再操作。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-01-04OpenAPI 错误码发生变更查看变更详情
    2023-10-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
    2023-06-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情