Method: projects.locations.batches.list

列出批次工作負載。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標，擁有此批次集合的父項。

授權需要指定資源 parent 的下列 IAM 權限：

  • dataproc.batches.list

查詢參數

參數
pageSize

integer

(非必要) 每個回應中傳回的批次數量上限。服務傳回的產品數量可能會少於這個值。預設的頁面大小為 20，最大頁面大小為 1000。
pageToken

string

(非必要) 從先前 batches.list 呼叫收到的網頁權杖。提供此符記即可擷取後續網頁。
filter

string

(非必要) 在回應中傳回批次的篩選器。

篩選器是邏輯運算式，可限制每個批次資源中各個欄位的值。篩選器會區分大小寫，且可能包含多個子句，並結合邏輯運算子 (AND/OR)。支援的欄位為 batchId、batchUuid、state、createTime 和 labels。

例如：state = RUNNING and createTime < "2023-01-01T00:00:00Z" 篩選器會篩除 2023-01-01 之前建立的資料批次，這些資料批次的狀態為 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

詳情請參閱驗證總覽一文。