Google

BigQuery Reservation API

A service to modify your BigQuery reservations.

Data & analytics#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

A service to modify your BigQuery reservations.

Endpoints 21

projects.locations.reservations

  • GETReturns information about the reservation./v1/:nameReturns information about the reservation.
  • GETLists all the reservations for the project in the specified location./v1/:parent/reservations?pageSize=0&pageToken=stringLists all the reservations for the project in the specified location.
  • POSTCreates a new reservation resource./v1/:parent/reservations?reservationId=stringCreates a new reservation resource.
  • POSTFail over a reservation to the secondary location/v1/:name:failoverReservationFail over a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary…

projects.locations.reservations.assignments

  • DELETEDeletes a assignment/v1/:nameDeletes a assignment. No expansion will happen. Example: * Organization organizationA contains two projects, project1 and project2. * Reservation res1 exists…
  • PATCHUpdates an existing assignment/v1/:name?updateMask=stringUpdates an existing assignment. Only the priority field can be updated.
  • GETGets the access control policy for a resource/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. May return: * ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it. * An…
  • POSTSets an access control policy for a resource/v1/:resource:setIamPolicySets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Reservations To call this method, you must have the…
  • POSTGets your permissions on a resource/v1/:resource:testIamPermissionsGets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Reservations No Google IAM…
  • GETLists assignments/v1/:parent/assignments?pageSize=0&pageToken=stringLists assignments. Only explicitly created assignments will be returned. Example: * Organization organizationA contains two projects, project1 and project2. *…
  • POSTCreates an assignment object which allows the given project to submit jobs of a certain type using slots from the…/v1/:parent/assignments?assignmentId=stringCreates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource…
  • POSTMoves an assignment under a new reservation/v1/:name:moveMoves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change…

projects.locations

  • GETLooks up assignments for a specified resource for a particular region/v1/:parent:searchAllAssignments?pageSize=0&pageToken=string&query=stringLooks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be…
  • GETDeprecated: Looks up assignments for a specified resource for a particular region/v1/:parent:searchAssignments?pageSize=0&pageToken=string&query=stringDeprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project…
  • POSTUpgrades the edition for a list of reservations and capacity commitments/v1/:parent:upgradeEditionUpgrades the edition for a list of reservations and capacity commitments. You can only upgrade to a higher edition (from STANDARD to ENTERPRISE or…

projects.locations.capacityCommitments

  • GETLists all the capacity commitments for the admin project./v1/:parent/capacityCommitments?pageSize=0&pageToken=stringLists all the capacity commitments for the admin project.
  • POSTCreates a new capacity commitment resource./v1/:parent/capacityCommitments?capacityCommitmentId=string&enforceSingleAdminProjectPerOrg=trueCreates a new capacity commitment resource.
  • POSTMerges capacity commitments of the same plan into a single commitment/v1/:parent/capacityCommitments:mergeMerges capacity commitments of the same plan into a single commitment. The resulting capacity commitment has the greater commitment_end_time out of the…
  • POSTSplits capacity commitment to two commitments of the same plan and `commitment_end_time`/v1/:name:splitSplits capacity commitment to two commitments of the same plan and commitment_end_time. A common use case is to enable downgrading commitments. For example,…

projects.locations.reservationGroups

  • GETLists all the reservation groups for the project in the specified location./v1/:parent/reservationGroups?pageSize=0&pageToken=stringLists all the reservation groups for the project in the specified location.
  • POSTCreates a new reservation group./v1/:parent/reservationGroups?reservationGroupId=stringCreates a new reservation group.

API details

Base URL
https://bigqueryreservation.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter
Operations
21 operations on 15 pathsPOST 11GET 8PATCH 1DELETE 1
Main resources
projects.locations.reservations.assignments 8projects.locations.capacityCommitments 4projects.locations.reservations 4projects.locations 3projects.locations.reservationGroups 2
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the BigQuery Reservation API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the BigQuery Reservation API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Returns information about the reservation.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BigQuery Reservation API?

A service to modify your BigQuery reservations. It is listed under Data & analytics and has 21 endpoints.

Who publishes the BigQuery Reservation API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the BigQuery Reservation API?

Requests go to https://bigqueryreservation.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the BigQuery Reservation API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.

How many endpoints does the BigQuery Reservation API have?

21 operations on 15 paths (11 POST, 8 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.reservations.assignments, projects.locations.capacityCommitments, projects.locations.reservations, projects.locations.

Is forking the BigQuery Reservation API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.