Method: projects.locations.spokes.gatewayAdvertisedRoutes.list

List GatewayAdvertisedRoutes

HTTP request

GET https://networkconnectivity.googleapis.com/v1beta/{parent=projects/*/locations/*/spokes/*}/gatewayAdvertisedRoutes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource's name.

Authorization requires the following IAM permission on the specified resource parent:

  • networkconnectivity.spokes.list

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of results per page that should be returned.

pageToken

string

Optional. A page token, received from a previous gatewayAdvertisedRoutes.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to gatewayAdvertisedRoutes.list must match the call that provided the page token.

filter

string

An expression that filters the list of results.

orderBy

string

Sort the results by a certain order.

Request body

The request body must be empty.

Response body

Response for HubService.ListGatewayAdvertisedRoutes method.

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

JSON representation
{
  "gatewayAdvertisedRoutes": [
    {
      object (GatewayAdvertisedRoute)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
gatewayAdvertisedRoutes[]

object (GatewayAdvertisedRoute)

The requested gateway advertised routes.

nextPageToken

string

The token for the next page of the response. To see more results, use this value as the pageToken for your next request. If this value is empty, there are no more results.

unreachable[]

string

Hubs that could not be reached.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.