Method: projects.locations.list

Fetches locations that offer Google Kubernetes Engine.

HTTP request

GET https://container.googleapis.com/v1beta1/{parent=projects/*}/locations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Contains the name of the resource requested. Specified in the format 'projects/*'.

Request body

The request body must be empty.

Response body

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

ListLocationsResponse returns the list of all GKE locations and their recommendation state.

JSON representation
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Fields
locations[]

object (Location)

A full list of GKE locations.

nextPageToken

string

Only return ListLocationsResponse that occur after the pageToken. This value should be populated from the ListLocationsResponse.next_page_token if that response token was set (which happens when listing more Locations than fit in a single ListLocationsResponse).

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Location

Location returns the location name, and if the location is recommended for GKE cluster scheduling.

JSON representation
{
  "type": enum (LocationType),
  "name": string,
  "recommended": boolean
}
Fields
type

enum (LocationType)

Contains the type of location this Location is for. Regional or Zonal.

name

string

Contains the name of the resource requested. Specified in the format 'projects/*/locations/*'.

recommended

boolean

Whether the location is recomended for GKE cluster scheduling.

LocationType

LocationType is the type of GKE location, regional or zonal.

Enums
LOCATION_TYPE_UNSPECIFIED LOCATION_TYPE_UNSPECIFIED means the location type was not determined.
ZONE A GKE Location where Zonal clusters can be created.
REGION A GKE Location where Regional clusters can be created.
Was this page helpful? Let us know how we did:

Send feedback about...

Kubernetes Engine