Method: projects.locations.capacityCommitments.list

Lists all the capacity commitments for the admin project.

HTTP request

GET https://bigqueryreservation.googleapis.com/v1/{parent=projects/*/locations/*}/capacityCommitments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.capacityCommitments.list

Query parameters

Parameters
pageSize

integer

The maximum number of items to return.
pageToken

string

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

Request body

The request body must be empty.

Response body

The response for ReservationService.ListCapacityCommitments.

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

JSON representation 
{
  "capacityCommitments": [
    {
      object (CapacityCommitment)
    }
  ],
  "nextPageToken": string
}
Fields
capacityCommitments[]

object (CapacityCommitment)

List of capacity commitments 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.