Method: projects.locations.reservations.list

Lists all the reservations for the project in the specified location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The parent resource name containing project and location, e.g.: "projects/myproject/locations/US"

Query parameters

Parameters
pageSize

number

The maximum number of items to return.

pageToken

string

The nextPageToken value returned from a previous List request, if any.

filter

string

Can be used to filter out reservations based on names, capacity, etc, e.g.: filter="reservation.slot_capacity > 200" filter="reservation.name = "*dev/*"" Advanced filtering syntax can be here.

Request body

The request body must be empty.

Response body

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

The response for ReservationService.ListReservations.

JSON representation
{
  "reservations": [
    {
      object (Reservation)
    }
  ],
  "nextPageToken": string
}
Fields
reservations[]

object (Reservation)

List of reservations visible to the user.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Need help? Visit our support page.