Method: projects.locations.capacityCommitments.split
Splits capacity commitment to two commitments of the same plan and commitmentEndTime.
A common use case is to enable downgrading commitments.
For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes.
HTTP request
POST https://bigqueryreservation.googleapis.com/v1/{name=projects/*/locations/*/capacityCommitments/*}:split
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The resource name e.g.,: projects/myproject/locations/US/capacityCommitments/123
Authorization requires the following IAM permission on the specified resource name:
bigquery.capacityCommitments.update
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"slotCount": string
} |
| Fields |
slotCount |
string (int64 format)
Number of slots in the capacity commitment after the split.
|
Response body
The response for ReservationService.SplitCapacityCommitment.
If successful, the response body contains data with the following structure:
| Fields |
first |
object (CapacityCommitment)
First capacity commitment, result of a split.
|
second |
object (CapacityCommitment)
Second capacity commitment, result of a split.
|
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 endpoint facilitates the splitting of a capacity commitment into two separate commitments with the same plan and end time, often used for downgrading.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a \u003ccode\u003ePOST\u003c/code\u003e method to a specific URL with the format \u003ccode\u003ehttps://bigqueryreservation.googleapis.com/v1/{name=projects/*/locations/*/capacityCommitments/*}:split\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the \u003ccode\u003ename\u003c/code\u003e path parameter, which is a string representing the resource name, along with the \u003ccode\u003ebigquery.capacityCommitments.update\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a \u003ccode\u003eslotCount\u003c/code\u003e field representing the number of slots in the capacity commitment after the split, and it has to be an int64.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains two fields, \u003ccode\u003efirst\u003c/code\u003e and \u003ccode\u003esecond\u003c/code\u003e, each representing one of the capacity commitments resulting from the split.\u003c/p\u003e\n"]]],[],null,[]]
