文档

DescribeVcoRouteEntries - 查询IPsec连接下路由条目的信息

更新时间:

调用DescribeVcoRouteEntries接口查询IPsec连接下路由条目的信息。

调试

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

授权信息

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

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

请求参数

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

IPsec 连接所属的地域 ID。

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

cn-hangzhou
VpnConnectionIdstring

IPsec 连接 ID。

vco-p0w2jpkhi2eeop6q6****
RouteEntryTypestring

路由条目类型。取值:

  • custom(默认值):目的路由条目。
  • bgp:BGP 路由条目。
custom
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页的条目数。默认值:10。取值范围:1~50

10
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-4266****

返回参数

名称类型描述示例值
object

返回结果。

TotalCountinteger

列表条目数。

1
PageNumberinteger

列表的页码。

1
PageSizeinteger

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

10
VcoRouteEntriesarray<object>

路由条目信息列表。

object

路由条目信息。

VpnConnectionIdstring

IPsec 连接 ID。

vco-p0w2jpkhi2eeop6q6****
RouteDeststring

路由条目的目标网段。

192.168.10.0/24
NextHopstring

路由条目的下一跳。

vco-p0w2jpkhi2eeop6q6****
Weightinteger

目的路由条目的权重值。

  • 0:表示低优先级。
  • 100:表示高优先级。
100
Statestring

路由条目的状态。

  • published:表示当前目的路由条目已发布至转发路由器实例中。
  • Active:表示当前 BGP 路由条目可用。
published
RouteEntryTypestring

路由条目类型。

  • custom:表示当前路由条目为目的路由条目。
  • bgp:表示当前路由条目为 BGP 路由条目。
custom
CreateTimelong

创建目的路由条目的时间戳。

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

1658217008000
AsPathstring

BGP 路由条目经过的自治系统号列表。

[12000]
Communitystring

BGP 路由条目携带的 Community 值。

65535:65510
Sourcestring

BGP 路由条目的来源。

  • CLOUD:表示当前 BGP 路由条目是 IPsec 连接通过转发路由器学习到的。
  • VPN_BGP:表示当前 BGP 路由条目是 IPsec 连接从本地数据中心学习到的。
CLOUD
RequestIdstring

请求 ID。

E18980E8-C8C2-31BD-8156-AE2BBDEC87E1

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "VcoRouteEntries": [
    {
      "VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
      "RouteDest": "192.168.10.0/24",
      "NextHop": "vco-p0w2jpkhi2eeop6q6****",
      "Weight": 100,
      "State": "published",
      "RouteEntryType": "custom",
      "CreateTime": 1658217008000,
      "AsPath": "[12000]",
      "Community": "65535:65510",
      "Source": "CLOUD"
    }
  ],
  "RequestId": "E18980E8-C8C2-31BD-8156-AE2BBDEC87E1"
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.RouteEntryTypeThe specified RouteEntryType is invalid.指定的路由条目类型不合规范。
400Vco.StatusNotSupportThe current VPN connection state does not support this operation.当前的实例状态不支持该操作
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.您没有权限操作指定资源,请申请权限后再操作。
404InvalidVpnConnectionInstanceId.NotFoundThe specified vpn connection instance id does not exist.指定的VPN连接不存在,请您检查该VPN连接ID是否正确。

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

变更历史

变更时间变更内容概要操作
暂无变更历史