Method: projects.locations.list

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
IAM Permissions

Lists information about the supported locations for this service.

HTTP request

GET https://apim.googleapis.com/v1alpha/{name=projects/*}/locations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` The resource that owns the locations collection, if applicable.

name

string

The resource that owns the locations collection, if applicable.

Query parameters

Parameters

Parameters
`filter`	`string` A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"` , and is documented in more detail in AIP-160 .
`pageSize`	`integer` The maximum number of results to return. If not set, the service selects a default.
`pageToken`	`string` A page token received from the `nextPageToken` field in the response. Send that page token to receive the subsequent page.

filter

string

A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo" , and is documented in more detail in AIP-160 .

pageSize

integer

The maximum number of results to return. If not set, the service selects a default.

pageToken

string

A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.

Request body

The request body must be empty.

Response body

The response message for Locations.ListLocations .

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

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

Fields

Fields
`locations[]`	`object ( Location )` A list of locations that matches the specified filter in the request.
`nextPageToken`	`string` The standard List next-page token.

locations[]

object ( Location )

A list of locations that matches the specified filter in the request.

nextPageToken

string

The standard List next-page token.

Authorization scopes

Requires the following OAuth scope:

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

IAM Permissions

Requires the following IAM permission on the name resource:

apim.locations.list

For more information, see the IAM documentation .