Method: projects.locations.global.networkPeerings.peeringRoutes.list

Lists the network peering routes exchanged over a peering connection.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the network peering 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/global/networkPeerings/my-peering

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.

filter

string

A filter expression that matches resources returned in the response. Currently, only filtering on the direction field is supported. To return routes imported from the peer network, provide "direction=INCOMING". To return routes exported from the VMware Engine network, provide "direction=OUTGOING". Other filter expressions return an error.

Request body

The request body must be empty.

Response body

Response message for VmwareEngine.ListPeeringRoutes

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

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.