全部产品
Search
文档中心

专有网络 VPC:CreateVcoRouteEntry - 为IPsec连接添加目的路由条目

更新时间:Mar 01, 2024

调用CreateVcoRouteEntry接口为IPsec连接添加目的路由条目。

接口说明

  • IPsec 连接需已绑定转发路由器实例。具体操作,请参见 CreateTransitRouterVpnAttachment
  • 不支持添加目标网段为 0.0.0.0/0 的目的路由。
  • 请勿添加目标网段为 100.64.0.0/10、100.64.0.0/10 下的子网段或者包含 100.64.0.0/10 网段的目的路由,该类路由条目会导致控制台无法显示 IPsec 连接的状态或者导致 IPsec 连接协商失败。
  • CreateVcoRouteEntry 接口属于异步接口,即系统先返回一个实例 ID,但该目的路由条目尚未创建成功,系统后台的创建任务仍在进行。您可以调用 DescribeVpnConnection 查询目的路由条目的创建状态:
    • 当 IPsec 连接处于 updating 状态时,表示目的路由条目正在创建中。
    • 当 IPsec 连接处于 attached 状态时,表示目的路由条目创建成功。
  • CreateVcoRouteEntry 接口不支持在同一 IPsec 连接下并发创建目的路由条目。

调试

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

授权信息

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

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

请求参数

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

IPsec 连接所属的地域 ID。

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

ap-southeast-2
VpnConnectionIdstring

IPsec 连接 ID。

vco-p0w2jpkhi2eeop6q6****
RouteDeststring

目的路由条目的目标网段。

192.168.10.0/24
Weightinteger

目的路由条目的权重值。取值:

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

目的路由条目的下一跳。

vco-p0w2jpkhi2eeop6q6****
Descriptionstring

目的路由条目的描述信息。

desctest
OverlayModestring

隧道协议。仅取值:Ipsec(默认值),表示 IPsec 隧道协议。

Ipsec
ClientTokenstring

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

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

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

返回参数

名称类型描述示例值
object

返回结果。

VpnConnectionIdstring

IPsec 连接的 ID。

vco-p0w2jpkhi2eeop6q6****
RouteDeststring

目的路由条目的目标网段。

192.168.10.0/24
NextHopstring

目的路由条目的下一跳。

vco-p0w2jpkhi2eeop6q6****
Weightinteger

目的路由条目的权重值。

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

隧道协议。

仅取值:Ipsec,表示 IPsec 隧道协议。

Ipsec
Statestring

目的路由条目的发布状态。

仅取值:published,表示当前路由条目已发布至转发路由器实例中。

published
CreateTimelong

创建目的路由条目的时间戳。单位:毫秒。

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

1658387202664
RequestIdstring

请求 ID。

CFC4D13B-E680-3985-95B1-87AA155481DF
Descriptionstring

目的路由条目的描述信息。

desctest

示例

正常返回示例

JSON格式

{
  "VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
  "RouteDest": "192.168.10.0/24",
  "NextHop": "vco-p0w2jpkhi2eeop6q6****",
  "Weight": 100,
  "OverlayMode": "Ipsec",
  "State": "published",
  "CreateTime": 1658387202664,
  "RequestId": "CFC4D13B-E680-3985-95B1-87AA155481DF",
  "Description": "desctest"
}

错误码

HTTP status code错误码错误信息描述
400Resource.QuotaFullThe quota of resource is full资源配额已达上限。
400VpnConnection.ConfiguringThe specified service is configuring.服务正在配置中,请您稍后再试。
400VpnConnection.FinancialLockedThe specified service is financial locked.指定的服务欠费锁定。
400VpnRouteEntry.AlreadyExistsThe specified route entry is already exist.该路由已存在。
400VpnRouteEntry.ConflictThe specified route entry has conflict.路由条目存在冲突。
400VpnRouteEntry.ConflictSSLThe specified route entry has conflict with SSL client.路由条目与SSL客户端冲突。
400VpnRouteEntry.BackupRouteValidate backup route entry failed.主备路由条目校验失败。
400InvalidNextHop.NotFoundThe specified NextHop does not exist.路由指定的下一跳不存在
400IllegalParam.RouteDestThe specified RouteDest is invalid目的地址不合法。
400OperationFailed.InvalidCidrBlockOperation failed because the specified network block is invalid.网段不合法。
400QuotaExceeded.VpnRouteEntryThe number of route entries to the VPN gateway in the VPC routing table has reached the quota limit.VPC路由表中指向VPN网关的路由条目已经达到配额限制。
400TaskConflictThe operation is too frequent, please wait a moment and try again.操作过于频繁,请稍等一会再重试
400Resource.QuotaFullThe resources you are operating have reached the upper limit of the quota. Please increase the quota or use other solutions to avoid it according to the VPN operation document.您现在所操作的资源目前已经达到了配额的上限,请参考VPN操作文档,进行配额提升或者使用其他方案进行规避。
400Resource.PbrRouteQuotaFullThe quota of Policy-based route is full.策略路由配额超限
400CreatePbrRoutesQuotaFull.QuotaFullThe number of policy routes exceeds the quota limit.策略路由数量超过配额限制。
400CreateDbrRoutesQuotaFull.QuotaFullThe number of created destination routes exceeds the quota limit.创建目的路由数量超过配额限制。
403Forbbiden.SubUserUser not authorized to operate on the specified resource.用户无权限操作此资源。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
404InvalidVpnConnectionInstanceId.NotFoundThe specified vpn connection instance id does not exist.指定的VPN连接不存在,请您检查该VPN连接ID是否正确。

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

变更历史

变更时间变更内容概要操作
2024-01-04OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404