Method: projects.locations.global.hubs.listSpokes

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

HTTP request

GET https://networkconnectivity.googleapis.com/v1/{name=projects/*/locations/global/hubs/*}:listSpokes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the hub.

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

  • networkconnectivity.hubs.listSpokes

Query parameters

Parameters
spokeLocations[]

string

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spokeLocations field is populated, the list of results includes only spokes in the specified location. If the spokeLocations field is not populated, the list of results includes spokes in all locations.
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 name or createTime.
view

enum (SpokeView)

The view of the spoke to return. The view that you use determines which spoke fields are included in the response.

Request body

The request body must be empty.

Response body

The response for HubService.ListHubSpokes.

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. The spoke fields can be partially populated based on the view field in the request message.
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.

SpokeView

Enum that controls which spoke fields are included in the response.

Enums
SPOKE_VIEW_UNSPECIFIED The spoke view is unspecified. When the spoke view is unspecified, the API returns the same fields as the BASIC view.
BASIC Includes name, createTime, hub, uniqueId, state, reasons, and spokeType. This is the default value.
DETAILED Includes all spoke fields except labels. You can use the DETAILED view only when you set the spokeLocations field to [global].