Queries 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 DescribeVpnPbrRouteEntries

The name of this action. Value: DescribeVpnPbrRouteEntries.

RegionId String Yes cn-hangzhou

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

VpnGatewayId String Yes vpn-bp1a3kqjiiq9legfx****

The ID of the VPN Gateway.

PageNumber Integer No 10

The page number. Default value: 1.

PageSize Integer No 10

The number of rows per page in the paged query. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example value Description
PageNumber Integer 1

The current page number.

PageSize Integer   10

The number of entries per page.

RequestId String 5BE01CD7-5A50-472D-AC14-CA181C5C03BE

 The ID of the request.

TotalCount Integer 12

The number of queried entries.

VpnPbrRouteEntries

The details of the VPN policy route.

CreateTime Long 1492747187000

The time when the policy route was created.

NextHop String vco-bp15oes1py4i66rmd****

The next hop of the policy route.

RouteDest String 10.0.0.0/24

The destination CIDR block of the policy route.

RouteSource String 192.168.0.0/24

The source CIDR block of the policy route.

State String published

The status of the VPN policy route. Valid values:

  • published: The VPN policy route is published.
  • normal: The VPN 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=DescribeVpnPbrRouteEntries
&RegionId=cn-hangzhou
&VpnGatewayId=vpn-bp1a3kqjiiq9legfx****
&<CommonParameters>

Response example

XML format

<DescribeVpnPbrRouteEntriesResponse>
	  <PageNumber>1</PageNumber>
	  <TotalCount>1</TotalCount>
	  <RequestId>E5D94DC7-AEC7-4E73-A203-61B04D1F1160</RequestId>
	  <PageSize>10</PageSize>
	  <VpnPbrRouteEntries>
		    <VpnPbrRouteEntry>
			      <RouteDest>10.0.0.0/32</RouteDest>
			      <VpnInstanceId>vpn-bp1cmw7jh1nfe43m9****</VpnInstanceId>
			      <State>published</State>
			      <Weight>100</Weight>
			      <CreateTime>1563881012000</CreateTime>
			      <NextHop>vco-bp1tui07ob10fmuro****</NextHop>
			      <RouteSource>11.0.0.0/32</RouteSource>
		    </VpnPbrRouteEntry>
	  </VpnPbrRouteEntries>
</DescribeVpnPbrRouteEntriesResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":10,
	"RequestId":"E5D94DC7-AEC7-4E73-A203-61B04D1F1160",
	"VpnPbrRouteEntries":{
		"VpnPbrRouteEntry":[
			{
				"RouteDest":"10.0.0.0/32",
				"VpnInstanceId":"vpn-bp1cmw7jh1nfe43m9****",
				"Weight":100,
				"State":"published",
				"RouteSource":"11.0.0.0/32",
				"NextHop":"vco-bp1tui07ob10fmuro****",
				"CreateTime":1563881012000
			}
		]
	}
}

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.

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