Method: projects.locations.privateConnections.peeringRoutes.list

Lists the private connection routes exchanged over a peering connection.

HTTP request

GET https://vmwareengine.googleapis.com/v1/{parent=projects/*/locations/*/privateConnections/*}/peeringRoutes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the private connection to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1/privateConnections/my-connection

Query parameters

Parameters
pageSize

integer

The maximum number of peering routes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
pageToken

string

A page token, received from a previous peeringRoutes.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to peeringRoutes.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for VmwareEngine.ListPrivateConnectionPeeringRoutes

JSON representation 
{
  "peeringRoutes": [
    {
      object (PeeringRoute)
    }
  ],
  "nextPageToken": string
}
Fields
peeringRoutes[]

object (PeeringRoute)

A list of peering routes.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

PeeringRoute

Exchanged network peering route.

JSON representation 
{
  "destRange": string,
  "type": enum (Type),
  "nextHopRegion": string,
  "priority": string,
  "imported": boolean,
  "direction": enum (Direction)
}
Fields
destRange

string

Output only. Destination range of the peering route in CIDR notation.
type

enum (Type)

Output only. Type of the route in the peer VPC network.
nextHopRegion

string

Output only. Region containing the next hop of the peering route. This field only applies to dynamic routes in the peer VPC network.
priority

string (int64 format)

Output only. The priority of the peering route.
imported

boolean

Output only. True if the peering route has been imported from a peered VPC network; false otherwise. The import happens if the field NetworkPeering.importCustomRoutes is true for this network, NetworkPeering.exportCustomRoutes is true for the peer VPC network, and the import does not result in a route conflict.
direction

enum (Direction)

Output only. Direction of the routes exchanged with the peer network, from the VMware Engine network perspective:

  • Routes of direction INCOMING are imported from the peer network.
  • Routes of direction OUTGOING are exported from the intranet VPC network of the VMware Engine network.

Type

The type of the peering route.

Enums
TYPE_UNSPECIFIED Unspecified peering route type. This is the default value.
DYNAMIC_PEERING_ROUTE Dynamic routes in the peer network.
STATIC_PEERING_ROUTE Static routes in the peer network.
SUBNET_PEERING_ROUTE Created, updated, and removed automatically by Google Cloud when subnets are created, modified, or deleted in the peer network.

Direction

The direction of the exchanged routes.

Enums
DIRECTION_UNSPECIFIED Unspecified exchanged routes direction. This is default.
INCOMING Routes imported from the peer network.
OUTGOING Routes exported to the peer network.