Method: projects.regions.jobs.list

Lists regions/{region}/jobs in a project.

HTTP request

GET https://dataproc.googleapis.com/v1/projects/{projectId}/regions/{region}/jobs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

Required. The ID of the Google Cloud Platform project that the job belongs to.

Authorization requires the following Google IAM permission on the specified resource projectId:

  • dataproc.jobs.list

region

string

Required. The Cloud Dataproc region in which to handle the request.

Query parameters

Parameters
pageSize

number

Optional. The number of results to return in each response.

pageToken

string

Optional. The page token, returned by a previous call, to request the next page of results.

clusterName

string

Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

jobStateMatcher

enum(JobStateMatcher)

Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

If filter is provided, jobStateMatcher will be ignored.

filter

string

Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:

[field = value] AND [field [= value]] ...

where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

status.state = ACTIVE AND labels.env = staging AND labels.starred = *

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

A list of jobs in a project.

JSON representation
{
  "jobs": [
    {
      object(Job)
    }
  ],
  "nextPageToken": string
}
Fields
jobs[]

object(Job)

Output only. Jobs list.

nextPageToken

string

Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the pageToken in a subsequent

ListJobsRequest

.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

JobStateMatcher

A matcher that specifies categories of job states.

Enums
ALL Match all jobs, regardless of state.
ACTIVE Only match jobs in non-terminal states: PENDING, RUNNING, or CANCEL_PENDING.
NON_ACTIVE Only match jobs in terminal states: CANCELLED, DONE, or ERROR.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Dataproc