Method: projects.locations.batches.list

バッチ ワークロードを一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。このバッチのコレクションを所有する親。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • dataproc.batches.list

クエリ パラメータ

パラメータ
pageSize

integer

省略可。各レスポンスで返されるバッチの最大数。サービスが返す値はこれよりも少ないことがあります。デフォルトのページサイズは 20 で、最大ページサイズは 1,000 です。
pageToken

string

省略可。前回の batches.list 呼び出しから受け取ったページトークン。後続のページを取得するには、このトークンを指定します。
filter

string

省略可。レスポンスで返されるバッチのフィルタ。

フィルタは、各バッチリソースのさまざまなフィールドの値を制約する論理式です。フィルタは、大文字と小文字が区別され、論理演算子（AND/OR）で組み合わせた複数の句を含めることができます。サポートされているフィールドは batchId、batchUuid、state、createTime、labels です。

たとえば、state = RUNNING and createTime < "2023-01-01T00:00:00Z" は、2023 年 1 月 1 日より前に作成された RUNNING 状態のバッチをフィルタします。state = RUNNING and labels.environment=production は、本番環境ラベルを持つ RUNNING 状態のバッチをフィルタします。

フィルタ構文の詳細とサポートされている比較の一覧については、https://google.aip.dev/assets/misc/ebnf-filtering.txt をご覧ください。
orderBy

string

省略可。バッチのリストを並べ替えるフィールド。

現在、サポートされている並べ替え順序は、指定なし（空）と、最近作成されたバッチを優先して並べ替える createTime desc のみです。

詳しくは、https://google.aip.dev/132#ordering をご覧ください。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

バッチ ワークロードのリスト。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "batches": [
    {
      object (Batch)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
フィールド
batches[]

object (Batch)

出力専用。指定されたコレクションのバッチ。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
unreachable[]

string

出力専用。レスポンスに含められなかったバッチのリスト。これらのリソースのいずれかを取得しようとすると、リスト レスポンスに含まれなかった理由が示される場合があります。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。