Method: projects.locations.spokes.list

Lists Spokes in a given project and location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent's resource name.

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

  • networkconnectivity.spokes.list

Query parameters

Parameters
pageSize

integer

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

pageToken

string

The page token.

filter

string

A filter expression that filters the results listed in the response.

orderBy

string

Sort the results by a certain order.

Request body

The request body must be empty.

Response body

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

The response for HubService.ListSpokes.

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

object (Spoke)

Spokes to be returned.

nextPageToken

string

The next pagination token in the List response. It should be used as pageToken for the following request. An empty value means no more result.

unreachable[]

string

Locations 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.