Method: projects.locations.spokes.list

Lists the Network Connectivity Center spokes in a specified project and location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource.

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

  • networkconnectivity.spokes.list

Query parameters

Parameters
pageSize

integer

The maximum number of results to return per page.

pageToken

string

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

The response for HubService.ListSpokes.

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

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

object (Spoke)

The requested spokes.

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

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.