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；最大页面大小为 1,000。
pageToken

string

可选。从之前的 batches.list 调用接收的页面令牌。提供此令牌以检索后续页面。
filter

string

可选。用于过滤要在响应中返回的批次的过滤条件。

过滤条件是一种逻辑表达式，用于约束每个批量资源中各个字段的值。过滤条件区分大小写，并且可以包含多个子句以及逻辑运算符（AND/OR）。支持的字段为 batchId、batchUuid、state、createTime 和 labels。

例如，state = RUNNING and createTime < "2023-01-01T00:00:00Z" 过滤器用于过滤状态为 RUNNING 且创建时间早于 2023 年 1 月 1 日的批次。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

如需了解详情，请参阅身份验证概览。