Index
ReservationService
(Benutzeroberfläche)Assignment
(Meldung)Assignment.JobType
(enum)Assignment.State
(enum)BiReservation
(Meldung)CapacityCommitment
(Meldung)CapacityCommitment.CommitmentPlan
(enum)CapacityCommitment.State
(enum)CreateAssignmentRequest
(Meldung)CreateCapacityCommitmentRequest
(Meldung)CreateReservationRequest
(Meldung)DeleteAssignmentRequest
(Meldung)DeleteCapacityCommitmentRequest
(Meldung)DeleteReservationRequest
(Meldung)GetBiReservationRequest
(Meldung)GetCapacityCommitmentRequest
(Meldung)GetReservationRequest
(Meldung)ListAssignmentsRequest
(Meldung)ListAssignmentsResponse
(Meldung)ListCapacityCommitmentsRequest
(Meldung)ListCapacityCommitmentsResponse
(Meldung)ListReservationsRequest
(Meldung)ListReservationsResponse
(Meldung)MergeCapacityCommitmentsRequest
(Meldung)MoveAssignmentRequest
(Meldung)Reservation
(Meldung)SearchAssignmentsRequest
(Meldung)SearchAssignmentsResponse
(Meldung)SplitCapacityCommitmentRequest
(Meldung)SplitCapacityCommitmentResponse
(Meldung)UpdateBiReservationRequest
(Meldung)UpdateCapacityCommitmentRequest
(Meldung)UpdateReservationRequest
(Meldung)
ReservationService
Mit der API können Nutzer ihre BigQuery-Pauschalreservierungen verwalten.
Mit einer Reservierung werden Rechenressourcen in Form von Slots garantiert. Ein Slot ist in BigQuery eine Einheit der Rechenleistung, die Basiseinheit der Parallelverarbeitung. Bei einem Scan einer mehrfach partitionierten Tabelle wird ein einzelner Slot auf eine einzelne Partition der Tabelle angewandt. Eine Reservierungsressource liegt als untergeordnete Ressource des Admin-Projekts und des Standorts vor, z. B.: projects/myproject/locations/US/reservations/reservationName
.
Eine Kapazitätszusicherung bietet die Möglichkeit, Rechenkapazität für BigQuery-Jobs in Form von Slots über einen verbindlichen Nutzungszeitraum zu erwerben. Eine Ressource zur Kapazitätszusicherung liegt als untergeordnete Ressource des Admin-Projekts und des Standorts vor, z. B.: projects/myproject/locations/US/capacityCommitments/id
CreateAssignment | |
---|---|
Erstellt ein Zuweisungsobjekt, das es dem angegebenen Projekt ermöglicht, Jobs eines bestimmten Typs mithilfe von Slots aus der angegebenen Reservierung zu senden. Derzeit kann eine Ressource (Projekt, Ordner, Organisation) nur eine Zuweisung pro Kombination aus Jobtyp und Standort haben. Diese Reservierung wird für alle Jobs des entsprechenden Typs verwendet. Verschiedene Zuweisungen können auf verschiedenen Ebenen der Projekte, Ordner oder Organisationshierarchie erstellt werden. Während der Abfrageausführung wird die Zuweisung auf Projekt-, Ordner- und Organisationsebene in dieser Reihenfolge gesucht. Die erste gefundene Zuweisung wird auf die Abfrage angewendet. Beim Erstellen von Zuweisungen spielt es keine Rolle, ob andere Zuweisungen auf höheren Ebenen vorhanden sind. Beispiel:
Gibt Gibt
|
CreateCapacityCommitment | |
---|---|
Erstellt eine neue Ressource zur Kapazitätszusicherung.
|
CreateReservation | |
---|---|
Erstellt eine neue Reservierungsressource.
|
DeleteAssignment | |
---|---|
Löscht eine Zuweisung. Es findet keine Expansion statt. Beispiel:
In diesem Beispiel hat das Löschen der Zuweisung
|
DeleteCapacityCommitment | |
---|---|
Löscht eine Kapazitätszusicherung. Der Versuch, die Kapazitätszusicherung vor der "commitment_end_time" zu löschen, hat einen Fehler mit dem Fehlercode
|
DeleteReservation | |
---|---|
Löscht eine Reservierung. Gibt
|
GetBiReservation | |
---|---|
Ruft eine BI-Reservierung ab.
|
GetCapacityCommitment | |
---|---|
Gibt Informationen zur Kapazitätszusicherung zurück.
|
GetReservation | |
---|---|
Gibt Informationen zur Reservierung zurück.
|
ListAssignments | |
---|---|
Listet Zuweisungen auf. Es werden nur explizit erstellte Zuweisungen zurückgegeben. Beispiel:
In diesem Beispiel gibt ListAssignments einfach die beiden obigen Zuweisungen für die Reservierung Der Platzhalter "-" kann für Reservierungen in der Anfrage verwendet werden. In diesem Fall gehören alle Zuweisungen zum angegebenen Projekt und der Standort wird aufgeführt. Hinweis: "-" kann weder für Projekte noch für Standorte verwendet werden.
|
ListCapacityCommitments | |
---|---|
Listet alle Kapazitätszusicherungen für das Administrationsprojekt auf.
|
ListReservations | |
---|---|
Listet alle Reservierungen für das Projekt am angegebenen Ort auf.
|
MergeCapacityCommitments | |
---|---|
Führt Kapazitätszusicherungen desselben Tarifs zusammen. Die sich daraus ergebende Kapazitätszusicherung hat das spätere Zusicherungsende (commitment_end_time out) von den zu verschmelzenden Kapazitätszusicherungen. Wenn Sie versuchen, Kapazitätszusicherungen unterschiedlicher Tarife zusammenzuführen, schlägt der Vorgang mit dem Fehlercode
|
MoveAssignment | |
---|---|
Verschiebt eine Zuweisung unter eine neue Reservierung. Dies unterscheidet sich vom Entfernen einer vorhandenen Zuweisung und dem Erstellen einer neuen Zuweisung durch eine Transaktionsänderung, die sicherstellt, dass einem Zuweisenden immer eine Reservierung zugewiesen ist.
|
SearchAssignments | |
---|---|
Sucht nach Zuweisungen für eine angegebene Ressource in einer bestimmten Region. Wenn sich die Anfrage auf ein Projekt bezieht:
Das Gleiche gilt, wenn es sich bei der Anfrage um einen Ordner handelt. Wenn sich die Anfrage auf eine Organisation bezieht, werden Zuweisungen, die für die Organisation erstellt wurden, zurückgegeben (Organisationen haben keine Ancestors). Im Vergleich zu ListAssignments gibt es einige Unterschiede:
Hinweis: "-" kann weder für Projekte noch für Standorte verwendet werden.
|
SplitCapacityCommitment | |
---|---|
Teilt die Kapazitätszusicherung auf zwei Zusicherungen desselben Tarifs und mit demselben Zusicherungsende (commitment_end_time) auf. Ein häufiger Anwendungsfall ist das Downgrade von Zusicherungen. Wenn Sie beispielsweise ein Downgrade von 10.000 auf 8.000 Slots ausführen möchten, können Sie eine Kapazitätszusicherung von 10.000 auf 2.000 und 8.000 aufteilen. Dann ändern Sie den Plan des ersten auf
|
UpdateBiReservation | |
---|---|
Aktualisiert eine BI-Reservierung. Nur die in der Eine Singleton BI-Reservierung ist immer mit der Standardgröße 0 vorhanden. Zum Reservieren von BI-Kapazität muss sie auf einen Wert größer 0 aktualisiert werden. Zum Freigeben der BI-Kapazität muss die Reservierungsgröße auf 0 gesetzt werden.
|
UpdateCapacityCommitment | |
---|---|
Aktualisiert eine vorhandene Kapazitätszusicherung. Nur die Felder Das Feld "plan" kann nur in einen Tarif mit einem längeren Zusicherungszeitraum geändert werden. Wenn Sie auf einen Tarif mit einem kürzeren Zusicherungszeitraum umstellen, schlägt der Vorgang mit dem Fehlercode
|
UpdateReservation | |
---|---|
Aktualisiert eine vorhandene Reservierungsressource.
|
Zuweisung
Eine Zuweisung ermöglicht einem Projekt mithilfe von Slots der angegebenen Reservierung das Senden von Jobs eines bestimmten Typs.
Felder | |
---|---|
name |
Nur Ausgabe Der Name der Ressource, z. B.: |
assignee |
Die Ressource, die die Reservierung nutzt, z. B.: |
job_type |
Die Arten der von der Reservierung genutzten Jobs. |
state |
Nur Ausgabe Status der Zuweisung. |
JobType
Arten von Jobs, die bei Verwendung der Reservierung angegeben werden können.
Enums | |
---|---|
JOB_TYPE_UNSPECIFIED |
Ungültiger Typ. Anfragen mit diesem Wert werden mit dem Fehlercode google.rpc.Code.INVALID_ARGUMENT abgelehnt. |
PIPELINE |
Die Reservierung wird von Pipelinejobs (Laden/Exportieren) aus dem Projekt verwendet. |
QUERY |
Die Reservierung wird von Abfragejobs aus dem Projekt verwendet. |
Status
Die Zuweisung bleibt im Status PENDING, wenn keine aktive Kapazitätszusicherung vorhanden ist. Ihr Status wechselt zu ACTIVE, wenn eine Kapazitätszusicherung aktiviert wird.
Enums | |
---|---|
STATE_UNSPECIFIED |
Ungültiger Statuswert. |
PENDING |
Abfragen von Empfängern von Zuweisungen werden auf On-Demand-Basis ausgeführt, wenn die zugehörige Zuweisung aussteht. |
ACTIVE |
Die Zuweisung ist einsatzbereit. |
BiReservation
Stellt eine BI-Reservierung dar.
Felder | |
---|---|
name |
Der Ressourcenname der Singleton-BI-Reservierung. Reservierungsnamen haben das Format |
update_time |
Nur Ausgabe Der Zeitstempel der letzten Aktualisierung einer Reservierung. |
size |
Größe einer Reservierung in Byte. |
CapacityCommitment
Eine Kapazitätszusicherung bietet die Möglichkeit, für einen verbindlichen Nutzungszeitraum für BigQuery-Jobs Rechenkapazität in Form von Slots zu erwerben. Jährliche Zusicherungen werden standardmäßig verlängert. Zusicherungen können nach Ablauf der Zusicherung entfernt werden.
Um die jährliche Zusicherung zu entfernen, muss der Tarif zuerst in monatlich oder Flex geändert werden.
Eine Ressource zur Kapazitätszusicherung liegt als untergeordnete Ressource des Admin-Projekts vor.
Felder | |
---|---|
name |
Nur Ausgabe Der Ressourcenname der Kapazitätszusicherung, z. B. |
slot_count |
Die Anzahl an Slots in dieser Zusicherung. |
plan |
Tarif mit Zusicherung für die Kapazitätszusicherung. |
state |
Nur Ausgabe Status der Zusicherung. |
commitment_end_time |
Nur Ausgabe Das Ende des aktuellen Zusicherungszeitraums. Gilt nur für Kapazitätszusicherungen mit dem Status ACTIVE. |
failure_status |
Nur Ausgabe Bei einem Zusicherungstarif mit dem Status FAILED wird die Fehlerursache angegeben. |
renewal_plan |
Der Tarif, in den diese Kapazitätszusicherung konvertiert wird, nachdem das Zusicherungsende (commitment_end_time) verstrichen ist. Sobald der Tarif geändert wurde, wird der Zusicherungszeitraum gemäß dem Zusicherungstarif verlängert. Gilt nur für JÄHRLICHE und TEST-Zusicherungen. |
CommitmentPlan
Der aktuelle Zusicherungszeitraum wird vom Zusicherungstarif bestimmt. Die Kapazitätszusicherung kann während des Zusicherungszeitraums nicht gelöscht werden.
Enums | |
---|---|
COMMITMENT_PLAN_UNSPECIFIED |
Ungültiger Tarifwert. Anfragen mit diesem Wert werden mit dem Fehlercode google.rpc.Code.INVALID_ARGUMENT abgelehnt. |
FLEX |
Für Flex-Zusicherungen gilt ein Zusicherungszeitraum von einer Minute nach der AKTIVIERUNG. Danach befinden sie sich nicht mehr in einem Zusicherungszeitraum und können jederzeit entfernt werden. |
TRIAL |
Testzusicherungen haben einen Zusicherungszeitraum von 182 Tagen nach ihrer AKTIVIERUNG. Danach werden sie anhand des Verlängerungstarifs in eine neue Zusicherung umgewandelt. Der standardmäßige Verlängerungtarif für die Testzusicherung ist Flex, sodass sie direkt nach Ablauf des Zusicherungszeitraums gelöscht werden kann. |
MONTHLY |
Monatliche Zusicherungen haben einen Zusicherungszeitraum von 30 Tagen nach ihrer AKTIVIERUNG. Danach befinden sie sich nicht mehr in einem Zusicherungszeitraum und können jederzeit entfernt werden. |
ANNUAL |
Jährliche Zusicherungen haben einen Zusicherungszeitraum von 365 Tagen nach ihrer AKTIVIERUNG. Danach werden sie anhand des Verlängerungstarifs in eine neue Zusicherung umgewandelt. |
Status
Kapazitätszusicherungen können entweder sofort in den Status ACTIVE übergehen oder ihr Status wechselt von PENDING zu ACTIVE oder FAILED.
Enums | |
---|---|
STATE_UNSPECIFIED |
Ungültiger Statuswert. |
PENDING |
Die Bereitstellung der Kapazitätszusicherung steht aus. Eine ausstehende Kapazitätszusicherung trägt nicht zur "slot_capacity" des übergeordneten Elements bei. |
ACTIVE |
Sobald die Slots bereitgestellt sind, wird die Kapazitätszusicherung aktiviert. Der "slot_count" wird zur "slot_capacity" des übergeordneten Elements hinzugefügt. |
FAILED |
Die Kapazitätszusicherung konnte vom Back-End nicht aktiviert werden. |
CreateAssignmentRequest
Die Anfrage für ReservationService.CreateAssignment
. Hinweis: Für den betreffenden Empfänger der Zuweisung ist die Berechtigung "bigquery.reservationAssignments.create" erforderlich.
Felder | |
---|---|
parent |
Erforderlich Der Name der übergeordneten Ressource der Zuweisung, z. B. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
assignment |
Zu erstellende Zuweisungsressource. |
CreateCapacityCommitmentRequest
Die Anfrage für ReservationService.CreateCapacityCommitment
.
Felder | |
---|---|
parent |
Erforderlich Ressourcenname der übergeordneten Reservierung, z. B. projects/myproject/locations/US |
capacity_commitment |
Inhalt der zu erstellenden Kapazitätszusicherung. |
enforce_single_admin_project_per_org |
Bei "true" schlägt die Anfrage fehl, wenn ein anderes Projekt in der Organisation eine Kapazitätszusicherung enthält. |
CreateReservationRequest
Die Anfrage für ReservationService.CreateReservation
.
Felder | |
---|---|
parent |
Erforderlich Projekt, Speicherort, z. B. |
reservation_id |
Die Reservierungs-ID. Dieses Feld darf nur alphanumerische Kleinbuchstaben oder einen Bindestrich enthalten. Darf maximal 64 Zeichen lang sein. |
reservation |
Definition der neu zu erstellenden Reservierung. |
DeleteAssignmentRequest
Die Anfrage für ReservationService.DeleteAssignment
. Hinweis: Für den betreffenden Empfänger der Zuweisung ist die Berechtigung "bigquery.reservationAssignments.delete" erforderlich.
Felder | |
---|---|
name |
Erforderlich Name der Ressource, z. B. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
DeleteCapacityCommitmentRequest
Die Anfrage für ReservationService.DeleteCapacityCommitment
.
Felder | |
---|---|
name |
Erforderlich Ressourcenname der zu löschenden Kapazitätszusicherung, z. B. projects/myproject/locations/US/capacityCommitments/123 |
DeleteReservationRequest
Die Anfrage für ReservationService.DeleteReservation
.
Felder | |
---|---|
name |
Erforderlich Ressourcenname der abzurufenden Reservierung, z. B. |
GetBiReservationRequest
Eine Anfrage zum Abrufen einer Singleton-BI-Reservierung.
Felder | |
---|---|
name |
Erforderlich Name der angeforderten Reservierung, z. B. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
GetCapacityCommitmentRequest
Die Anfrage für ReservationService.GetCapacityCommitment
.
Felder | |
---|---|
name |
Erforderlich Ressourcenname der abzurufenden Kapazitätszusicherung, z. B. projects/myproject/locations/US/capacityCommitments/123 |
GetReservationRequest
Die Anfrage für ReservationService.GetReservation
.
Felder | |
---|---|
name |
Erforderlich Ressourcenname der abzurufenden Reservierung, z. B. |
ListAssignmentsRequest
Die Anfrage für ReservationService.ListAssignments
.
Felder | |
---|---|
parent |
Erforderlich Der Name der übergeordneten Ressource, z. B.:
oder:
Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
page_size |
Die maximale Anzahl von Elementen, die pro Seite zurückgegeben werden sollen. |
page_token |
Der Wert next_page_token wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. |
ListAssignmentsResponse
Die Antwort für ReservationService.ListAssignments
.
Felder | |
---|---|
assignments[] |
Liste der Zuweisungen, die für den Nutzer sichtbar sind. |
next_page_token |
Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind. |
ListCapacityCommitmentsRequest
Die Anfrage für ReservationService.ListCapacityCommitments
.
Felder | |
---|---|
parent |
Erforderlich Ressourcenname der übergeordneten Reservierung, z. B. projects/myproject/locations/US |
page_size |
Die maximale Anzahl der Elemente, die zurückzugeben sind. |
page_token |
Der Wert next_page_token wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. |
ListCapacityCommitmentsResponse
Die Antwort für ReservationService.ListCapacityCommitments
.
Felder | |
---|---|
capacity_commitments[] |
Liste der für den Nutzer sichtbaren Kapazitätszusicherungen. |
next_page_token |
Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind. |
ListReservationsRequest
Die Anfrage für ReservationService.ListReservations
.
Felder | |
---|---|
parent |
Erforderlich Der Name der übergeordneten Ressource, die das Projekt und den Standort beinhaltet, z. B.: "projects/myproject/locations/US" |
page_size |
Die maximale Anzahl von Elementen, die pro Seite zurückgegeben werden sollen. |
page_token |
Der Wert next_page_token wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. |
ListReservationsResponse
Die Antwort für ReservationService.ListReservations
.
Felder | |
---|---|
reservations[] |
Liste der Reservierungen, die für den Nutzer sichtbar sind. |
next_page_token |
Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind. |
MergeCapacityCommitmentsRequest
Die Anfrage für ReservationService.MergeCapacityCommitments
.
Felder | |
---|---|
parent |
Übergeordnete Ressource, die das Administrationsprojekt und den Standort identifiziert, z. B. projects/myproject/locations/us. |
capacity_commitment_ids[] |
IDs der zusammenzuführenden Kapazitätszusicherungen. Diese Kapazitätszusicherungen müssen unter dem in der übergeordneten Ressource angegebenen Administrationsprojekt und Standort vorhanden sein. |
MoveAssignmentRequest
Die Anfrage für ReservationService.MoveAssignment
.
Hinweis: Für die "destination_id" ist die Berechtigung "bigquery.reservationAssignments.create" erforderlich.
Hinweis: Für den betreffenden Empfänger der Zuweisung sind die Berechtigungen "bigquery.reservationAssignments.create" und "bigquery.reservationAssignments.delete" erforderlich.
Felder | |
---|---|
name |
Erforderlich Der Ressourcenname der Zuweisung, z. B. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
destination_id |
Die neue Reservierungs-ID, z. B.: |
Reservierung
Eine Reservierung ist ein Mechanismus, mit dessen Hilfe Nutzern Slots garantiert werden.
Felder | |
---|---|
name |
Der Ressourcenname der Reservierung, z. B.: |
slot_capacity |
Die Mindestanzahl der Slots, die dieser Reservierung zur Verfügung stehen. Ein Slot ist in BigQuery eine Einheit der Rechenleistung, insbesondere der Parallelverarbeitung. Abfragen, in denen diese Reservierung verwendet wird, belegen während der Laufzeit möglicherweise mehr Slots, wenn "ignore_idle_slots" auf "false" gesetzt ist. Wenn die Slotkapazität der neuen Reservierung die Slotkapazität der übergeordneten Reservierung übersteigt oder die gesamte Slotkapazität der neuen und allen gleichgeordneten Reservierungen die Slotkapazität der übergeordneten Reservierung übersteigt, wird für die Anfrage der Fehler |
ignore_idle_slots |
Bei "false" belegt jede Abfrage, die diese Reservierung verwendet, inaktive Slots aus anderen Reservierungen innerhalb desselben Administrationsprojekts. Bei "true" wird eine Abfrage, die diese Reservierung verwendet, höchstens mit der oben angegebenen Slotkapazität ausgeführt. |
SearchAssignmentsRequest
Die Anfrage für ReservationService.SearchAssignments
. Hinweis: Für den betreffenden Empfänger der Zuweisung ist die Berechtigung "bigquery.reservationAssignments.search" erforderlich.
Felder | |
---|---|
parent |
Erforderlich Der Ressourcenname des Admin-Projekts (mit Projekt und Standort), z. B. "projects/myproject/locations/US". |
query |
Geben Sie den Ressourcennamen als zuständige Person in der Abfrage an. Beispiele:
|
page_size |
Die maximale Anzahl von Elementen, die pro Seite zurückgegeben werden sollen. |
page_token |
Der Wert next_page_token wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. |
SearchAssignmentsResponse
Die Antwort für ReservationService.SearchAssignments
.
Felder | |
---|---|
assignments[] |
Liste der Zuweisungen, die für den Nutzer sichtbar sind. |
next_page_token |
Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind. |
SplitCapacityCommitmentRequest
Die Anfrage für ReservationService.SplitCapacityCommitment
.
Felder | |
---|---|
name |
Erforderlich Der Ressourcenname, z. B.: projects/myproject/locations/US/capacityCommitments/123 Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
slot_count |
Anzahl der Slots in der Kapazitätszusicherung nach der Aufteilung. |
SplitCapacityCommitmentResponse
Die Antwort für ReservationService.SplitCapacityCommitment
.
Felder | |
---|---|
first |
Erste Kapazitätszusicherung, Ergebnis einer Aufteilung. |
second |
Zweite Kapazitätszusicherung, Ergebnis einer Aufteilung. |
UpdateBiReservationRequest
Eine Anfrage zum Aktualisieren einer BI-Reservierung.
Felder | |
---|---|
bi_reservation |
Eine Reservierung, die aktualisiert werden soll. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
update_mask |
Eine Liste der Felder, die in dieser Anfrage aktualisiert werden sollen. |
UpdateCapacityCommitmentRequest
Die Anfrage für ReservationService.UpdateCapacityCommitment
.
Felder | |
---|---|
capacity_commitment |
Inhalt der zu aktualisierenden Kapazitätszusicherung. |
update_mask |
Standardfeldmaske für den Feldsatz, der aktualisiert werden soll. |
UpdateReservationRequest
Die Anfrage für ReservationService.UpdateReservation
.
Felder | |
---|---|
reservation |
Inhalt der zu aktualisierenden Reservierung. |
update_mask |
Standardfeldmaske für den Feldsatz, der aktualisiert werden soll. |