Method: projects.locations.batches.list

Répertorie les charges de travail par lot.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Élément parent, propriétaire de cette collection de lots.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • dataproc.batches.list

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de lots à renvoyer dans chaque réponse. Le service peut renvoyer un nombre inférieur à cette valeur. La taille de page par défaut est de 20 ; la taille de page maximale est de 1 000.
pageToken

string

Facultatif. Jeton de page reçu d'un appel batches.list précédent. Fournissez ce jeton pour récupérer la page suivante.
filter

string

Facultatif. Filtre pour les lots à renvoyer dans la réponse.

Un filtre est une expression logique qui limite les valeurs de divers champs dans chaque ressource de lot. Les filtres sont sensibles à la casse et peuvent contenir plusieurs clauses combinées à des opérateurs logiques (ET/OU). Les champs acceptés sont batchId, batchUuid, state, createTime et labels.

Par exemple, state = RUNNING and createTime < "2023-01-01T00:00:00Z" filtre les lots en cours d'exécution créés avant le 1er janvier 2023. state = RUNNING and labels.environment=production filtre les lots en cours d'exécution qui sont associés à un libellé d'environnement de production.

Consultez https://google.aip.dev/assets/misc/ebnf-filtering.txt pour obtenir une description détaillée de la syntaxe de filtrage et une liste des comparaisons acceptées.
orderBy

string

Facultatif. Champ(s) sur lequel trier la liste des lots.

Actuellement, les seuls ordres de tri acceptés sont "non spécifié" (vide) et createTime desc pour trier en premier les lots créés le plus récemment.

Pour en savoir plus, consultez la page https://google.aip.dev/132#ordering.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Liste des charges de travail par lot.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "batches": [
    {
      object (Batch)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Champs
batches[]

object (Batch)

Uniquement en sortie. Les lots de la collection spécifiée.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.
unreachable[]

string

Uniquement en sortie. Liste des lots qui n'ont pas pu être inclus dans la réponse. Si vous essayez d'obtenir l'une de ces ressources, vous pourrez peut-être déterminer pourquoi elle n'a pas été incluse dans la réponse de la liste.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.