调用CreateVpnRouteEntry接口为VPN网关实例创建目的路由。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateVpnRouteEntry

系统规定参数。取值：CreateVpnRouteEntry。

RegionId String 是 cn-hangzhou

VPN网关实例所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

ClientToken String 否 d7d24a21-f4ba-4454-9173-b3828dae****

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

由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
VpnGatewayId String 是 vpn-bp1a3kqjiiq9legfx****

VPN网关的ID。
RouteDest String 是 10.0.0.0/24

目的路由的目标网段。
NextHop String 是 vco-bp15oes1py4i66rmd****

目的路由的下一跳。
Weight Integer 是 0

目的路由的权重值，取值：

  • 0：低优先级。
  • 100：高优先级。
PublishVpc Boolean 是 true

是否发布目的路由到VPC，取值：

  • true：发布目的路由到VPC。
  • false：不发布目的路由到VPC。
Description String 否 mytest

目的路由的描述信息。
OverlayMode String 否 Ipsec

隧道协议，取值：Ipsec（IPsec隧道协议）。

返回数据

名称 类型 示例值 描述
NextHop String vco-bp15oes1py4i66rmd****

目的路由的下一跳。
Weight Integer 0

目的路由的权重值，取值：

  • 0：低优先级。
  • 100：高优先级。
RouteDest String 10.0.0.0/24

目的路由的目标网段。
RequestId String 5BE01CD7-5A50-472D-AC14-CA181C5C03BE

请求ID。
Description String mytest

目的路由的描述信息。
State String published

目的路由的状态。取值：

  • published：已发布。
  • normal：未发布。
CreateTime Long 1492747187000

目的路由的创建时间。
OverlayMode String Ipsec

隧道协议，取值：Ipsec（IPsec隧道协议）。

VpnInstanceId String vpn-bp1cmw7jh1nfe43m9****

VPN网关的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateVpnRouteEntry
&RegionId=cn-hangzhou
&ClientToken=d7d24a21-f4ba-4454-9173-b3828dae492b	
&VpnGatewayId=vpn-bp1a3kqjiiq9legfx****
&RouteDest=10.0.0.0/24
&NextHop=vco-bp15oes1py4i66rmd****	
&Weight=0
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateVpnRouteEntryResponse>
    <NextHop>vco-bp15oes1py4i66rmd****</NextHop>
    <Weight>0</Weight>
    <RouteDest>10.0.0.0/24</RouteDest>
    <RequestId>5BE01CD7-5A50-472D-AC14-CA181C5C03BE</RequestId>
    <Description>mytest</Description>
    <State>published</State>
    <CreateTime>1492747187000</CreateTime>
    <OverlayMode>Ipsec</OverlayMode>
    <VpnInstanceId>vpn-bp1cmw7jh1nfe43m9****</VpnInstanceId>
</CreateVpnRouteEntryResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextHop" : "vco-bp15oes1py4i66rmd****",
  "Weight" : 0,
  "RouteDest" : "10.0.0.0/24",
  "RequestId" : "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "Description" : "mytest",
  "State" : "published",
  "CreateTime" : 1492747187000,
  "OverlayMode" : "Ipsec",
  "VpnInstanceId" : "vpn-bp1cmw7jh1nfe43m9****"
}

错误码

HttpCode 错误码 错误信息 描述
400 Resource.QuotaFull The quota of resource is full 资源配额已达上限。
400 VpnGateway.Configuring The specified service is configuring. 服务正在配置中，请您稍后再试。
400 VpnGateway.FinancialLocked The specified service is financial locked. 该服务已欠费，请您先充值再操作。
400 OperationFailed.RouteConflict Operation failed because there is already a route in VPC route table to another VPN on the same network block. 在VPC路由表中同一网段上已经存在一条指向另一个VPN网关的路由。
400 QuotaExceeded.VpnRouteEntry The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit. VPC路由表中指向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. 您没有权限操作指定资源，请申请权限后再操作。
404 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist. 指定的 VPN 网关不存在，请您检查 VPN 网关是否正确。

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