Method: projects.locations.list

List all locations that provides at least one type of CMLE capability.

HTTP request

GET https://{endpoint}/v1/{parent=projects/*}/locations

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects).

Query parameters

Parameters
pageToken

string

Optional. A page token to request the next page of results.

You get the token from the nextPageToken field of the response from the previous call.
pageSize

integer

Optional. The number of locations to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the nextPageToken field.

The default value is 20, and the maximum page size is 100.

Request body

The request body must be empty.

Response body

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

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

object (Location)

Locations where at least one type of CMLE capability is available.
nextPageToken

string

Optional. Pass this token as the pageToken field of the request for a subsequent call.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.