- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.
HTTP request
GET https://bigquery.googleapis.com/bigquery/v2/projects/{projectId}/jobs
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
projectId |
Project ID of the jobs to list. |
Query parameters
Parameters | |
---|---|
allUsers |
Whether to display jobs owned by all users in the project. Default False. |
maxResults |
The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. |
minCreationTime |
Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned. |
maxCreationTime |
Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned. |
pageToken |
Page token, returned by a previous call, to request the next page of results. |
projection |
Restrict information returned to a set of selected fields Valid values of this enum field are:
,
|
stateFilter[] |
Filter for job state Valid values of this enum field are:
,
,
|
parentJobId |
If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs. |
Request body
The request body must be empty.
Response body
JobList is the response format for a jobs.list call.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "etag": string, "kind": string, "nextPageToken": string, "jobs": [ { "id": string, "kind": string, "jobReference": { object ( |
Fields | |
---|---|
etag |
A hash of this page of results. |
kind |
The resource type of the response. |
nextPageToken |
A token to request the next page of results. |
jobs[] |
tabledata.list of jobs that were requested. |
jobs[].id |
Unique opaque ID of the job. |
jobs[].kind |
The resource type. |
jobs[].jobReference |
Unique opaque ID of the job. |
jobs[].state |
Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed. |
jobs[].errorResult |
A result object that will be present only if the job has failed. |
jobs[].statistics |
Output only. Information about the job, including starting time and ending time of the job. |
jobs[].configuration |
Required. Describes the job configuration. |
jobs[].status |
[Full-projection-only] Describes the status of this job. |
jobs[].user_email |
[Full-projection-only] Email address of the user who ran the job. |
jobs[].principal_subject |
[Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities. |
unreachable[] |
A list of skipped locations that were unreachable. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations. Example: "europe-west5" |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/bigquery
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/bigquery.readonly
https://www.googleapis.com/auth/cloud-platform.read-only
For more information, see the Authentication Overview.