Creates a VPN policy route.

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
Action String Yes CreateVpnPbrRouteEntry

The name of this action. Value: CreateVpnPbrRouteEntry.

NextHop String Yes vco-bp15oes1py4i66rmd****

The next hop of the policy route.
PublishVpc Boolean Yes true

Indicates whether to publish the policy route to the VPC. Valid values:

  • true: The policy route is published to the VPC.
  • false: The policy route is not published to the VPC.
RegionId String Yes cn-hangzhou

The ID of the region to which the VPN policy route belongs. To query the region ID, call DescribeRegions.

RouteDest String Yes 10.0.0.0/24

The destination CIDR block of the policy route.
RouteSource String Yes 192.168.1.0/24

The source CIDR block of the policy route.
VpnGatewayId String Yes vpn-bp1a3kqjiiq9legfx****

The ID of the VPN Gateway.
Weight Integer Yes 0

The weight of the policy route. Valid values: 0|100.

ClientToken String No d7d24a21-f4ba-4454-9173-b3828dae492b

The client token used to guarantee the idempotence of the request.

The value of this parameter is generated by the client and must be unique among different requests. It must be 1 to 64 ASCII characters in length.

OverlayMode String No Ipsec

The overwrite mode.

Response parameters

Parameter Type Example value Description
CreateTime Long 1492747187000

The time when the VPN policy route was created.
NextHop String vco-bp15oes1py4i66rmd****

The next hop of the policy route.
OverlayMode String Ipsec

The overwrite mode.
RequestId String 5BE01CD7-5A50-472D-AC14-CA181C5C03BE

The ID of the request.
RouteDest String 10.0.0.0/24

The destination CIDR block of the policy route.
RouteSource String 192.168.1.0/24

The source CIDR block of the policy route.
State String normal

The status of the policy route. Valid values:

  • published: The policy route is published.
  • normal: The policy route is not published.
VpnInstanceId String vpn-bp1cmw7jh1nfe43m9****

The ID of the VPN Gateway.
Weight Integer 0

The weight of the policy route. Valid values: 0|100.

Examples

Request example


http(s)://[Endpoint]/? Action=CreateVpnPbrRouteEntry
&NextHop=vco-bp15oes1py4i66rmd****
&PublishVpc=true
&RegionId=cn-hangzhou
&RouteDest=10.0.0.0/24
&RouteSource=192.168.1.0/24
&VpnGatewayId=vpn-bp1a3kqjiiq9legfx****
&Weight=0
&<CommonParameters>

Response example

XML format 

<CreateVpnPbrRouteEntryResponse>
	  <RouteDest>10.0.0.0/24</RouteDest>
	  <RouteSource>192.168.1.0/24</RouteSource>
	  <VpnInstanceId>vpn-bp1cmw7jh1nfe43m9****</VpnInstanceId>
	  <OverlayMode>Ipsec</OverlayMode>
	  <State>published</State>
	  <Weight>100</Weight>
	  <CreateTime>1563873294331</CreateTime>
	  <NextHop>vco-bp1tui07ob10fmuro****</NextHop>
</CreateVpnPbrRouteEntryResponse>

JSON format 

{
	"RouteDest":"10.0.0.0/24",
	"VpnInstanceId":"vpn-bp1cmw7jh1nfe43m9****",
	"OverlayMode":"Ipsec",
	"Weight":100,
	"State":"published",
	"NextHop":"vco-bp1tui07ob10fmuro****",
	"CreateTime":1563873294331,
	"RouteSource":"192.168.1.0/24"
}

Errors

HTTP status code Error code Error message Description
403 Forbidden.SubUser User not authorized to operate on the specified resource as your account is created by another user. You are not authorized to use this resource. Apply for the permission and try again.
403 Forbidden User not authorized to operate on the specified resource. You are not authorized to use this resource. For more information, open a ticket.
400 Resource.QuotaFull The quota of resource is full. The resource quota has been reached.
404 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist. The specified VPN Gateway does not exist.
400 VpnGateway.Configuring The specified service is configuring. The specified service is being configured.
400 VpnGateway.FinancialLocked The specified service is financial locked. The specified service is locked due to insufficient account balance.

For a list of error codes, visit the API Error Center.