Method: projects.locations.batches.list

Mencantumkan workload batch.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Induk, yang memiliki kumpulan batch ini.

Otorisasi memerlukan izin IAM berikut pada resource parent yang ditentukan:

  • dataproc.batches.list

Parameter kueri

Parameter
pageSize

integer

Opsional. Jumlah maksimum batch yang akan ditampilkan dalam setiap respons. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Ukuran halaman default adalah 20; ukuran halaman maksimum adalah 1.000.

pageToken

string

Opsional. Token halaman yang diterima dari panggilan batches.list sebelumnya. Berikan token ini untuk mengambil halaman berikutnya.

filter

string

Opsional. Filter untuk batch yang akan ditampilkan dalam respons.

Filter adalah ekspresi logis yang membatasi nilai berbagai kolom di setiap resource batch. Filter peka huruf besar/kecil, dan dapat berisi beberapa klausa yang digabungkan dengan operator logika (AND/OR). Kolom yang didukung adalah batchId, batchUuid, state, createTime, dan labels.

Misalnya, filter state = RUNNING and createTime < "2023-01-01T00:00:00Z" untuk batch dalam status RUNNING yang dibuat sebelum 01-01-2023. state = RUNNING and labels.environment=production memfilter batch dalam status BERJALAN yang memiliki label lingkungan produksi.

Lihat https://google.aip.dev/assets/misc/ebnf-filtering.txt untuk deskripsi mendetail tentang sintaksis filter dan daftar perbandingan yang didukung.

orderBy

string

Opsional. Kolom yang akan digunakan untuk mengurutkan daftar batch.

Saat ini, satu-satunya urutan pengurutan yang didukung adalah tidak ditentukan (kosong) dan createTime desc untuk mengurutkan menurut batch yang dibuat baru-baru ini terlebih dahulu.

Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Daftar workload batch.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "batches": [
    {
      object (Batch)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Kolom
batches[]

object (Batch)

Hanya output. Batch dari koleksi yang ditentukan.

nextPageToken

string

Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

unreachable[]

string

Hanya output. Daftar Batch yang tidak dapat disertakan dalam respons. Mencoba mendapatkan salah satu resource ini dapat menunjukkan alasan resource tersebut tidak disertakan dalam respons daftar.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.