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/bigqueryhttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-02 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[[["\u003cp\u003eThis webpage details how to list all capacity commitments for an admin project using the BigQuery Reservation API.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003eGET\u003c/code\u003e operation to a specific URL using gRPC Transcoding syntax, and the parent path parameter is required.\u003c/p\u003e\n"],["\u003cp\u003eThe request supports optional query parameters \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e to control the number of items returned and pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and the successful response body contains a list of \u003ccode\u003ecapacityCommitments\u003c/code\u003e and an optional \u003ccode\u003enextPageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe process requires one of two OAuth scopes for authorization: \u003ccode\u003ehttps://www.googleapis.com/auth/bigquery\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
