Method: projects.locations.list

Lists information about the supported locations for this service.

HTTP request

GET https://cloudfunctions.googleapis.com/v1beta2/{name}/locations

Path parameters

Parameters
name

string

The resource that owns the locations collection, if applicable. It takes the form projects/{project_id}.

Query parameters

Parameters
filter

string

The standard list filter.

pageSize

number

The standard list page size.

pageToken

string

The standard list page token.

Request body

The request body must be empty.

Response body

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

The response message for Locations.ListLocations.

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

object(Location)

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

nextPageToken

string

The standard List next-page token.

Authorization

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

Location

A resource that represents Google Cloud Platform location.

JSON representation
{
  "name": string,
  "locationId": string,
  "labels": {
    string: string,
    ...
  },
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
}
Fields
name

string

Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"

locationId

string

The canonical id for this location. For example: "us-east1".

labels

map (key: string, value: string)

Cross-service attributes for the location. For example

{"cloud.googleapis.com/region": "us-east1"}

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

metadata

object

Service-specific metadata. For example the available capacity at the given location.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

Try it!

Send feedback about...

Cloud Functions