Method: projects.locations.batches.list

Listet Batcharbeitslasten auf.

HTTP-Anfrage

GET https://dataproc.googleapis.com/v1/{parent=projects/*/locations/*}/batches

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Pflichtangabe. Das übergeordnete Element, das dieser Sammlung von Batches zugewiesen ist.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • dataproc.batches.list

Suchparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl von Batches, die in jeder Antwort zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Die Standardseitengröße ist 20, die maximale Seitengröße ist 1.000.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen batches.list-Aufruf empfangen wurde. Geben Sie dieses Token an, um die nachfolgende Seite abzurufen.
filter

string

Optional. Ein Filter für die Batches, die in der Antwort zurückgegeben werden sollen.

Ein Filter ist ein logischer Ausdruck, der die Werte verschiedener Felder in jeder Batchressource einschränkt. Bei Filtern wird die Groß- und Kleinschreibung berücksichtigt. Sie können mehrere Klauseln mit logischen Operatoren (AND/OR) enthalten. Unterstützte Felder sind batchId, batchUuid, state, createTime und labels.

Beispiel: state = RUNNING and createTime < "2023-01-01T00:00:00Z" filtert für Batches im Status „RUNNING“, die vor dem 01.01. 2023 erstellt wurden. state = RUNNING and labels.environment=production filtert nach Batches im Status „RUNNING“ (AKTIV), die ein Label für die Produktionsumgebung haben.

Eine detaillierte Beschreibung der Filtersyntax und eine Liste der unterstützten Vergleiche finden Sie unter https://google.aip.dev/assets/misc/ebnf-filtering.txt.
orderBy

string

Optional. Feld(er), nach dem bzw. denen die Liste der Batches sortiert werden soll.

Derzeit werden nur die Sortierungen „nicht angegeben“ (leer) und createTime desc unterstützt, um nach den zuletzt erstellten Batches zu sortieren.

Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Eine Liste von Batcharbeitslasten.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "batches": [
    {
      object (Batch)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Felder
batches[]

object (Batch)

Nur Ausgabe. Die Batches aus der angegebenen Sammlung.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.
unreachable[]

string

Nur Ausgabe. Liste der Batches, die nicht in die Antwort aufgenommen werden konnten. Wenn Sie versuchen, eine dieser Ressourcen abzurufen, kann das Aufschluss darüber geben, warum sie nicht in der Listenantwort enthalten war.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.