Method: jobs.list

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

string

Project ID of the jobs to list.

Query parameters

Parameters
allUsers

boolean

Whether to display jobs owned by all users in the project. Default False.

maxResults

number

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

minCreationTime

string

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

string (UInt64Value format)

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

string

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

projection

enum

Restrict information returned to a set of selected fields

Valid values of this enum field are:

minimal

,

MINIMAL

,

full

,

FULL

stateFilter

enum

Filter for job state

Valid values of this enum field are:

done

,

DONE

,

pending

,

PENDING

,

running

,

RUNNING

Request body

The request body must be empty.

Response body

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 (JobReference)
      },
      "state": string,
      "errorResult": {
        object (ErrorProto)
      },
      "statistics": {
        object (JobStatistics)
      },
      "configuration": {
        object (JobConfiguration)
      },
      "status": {
        object (JobStatus)
      },
      "user_email": string
    }
  ]
}
Fields
etag

string

A hash of this page of results.

kind

string

The resource type of the response.

nextPageToken

string

A token to request the next page of results.

jobs[]

object

tabledata.list of jobs that were requested.

jobs[].id

string

Unique opaque ID of the job.

jobs[].kind

string

The resource type.

jobs[].jobReference

object (JobReference)

Unique opaque ID of the job.

jobs[].state

string

Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.

jobs[].errorResult

object (ErrorProto)

A result object that will be present only if the job has failed.

jobs[].statistics

object (JobStatistics)

Output only. Information about the job, including starting time and ending time of the job.

jobs[].configuration

object (JobConfiguration)

[Required] Describes the job configuration.

jobs[].status

object (JobStatus)

[Full-projection-only] Describes the status of this job.

jobs[].user_email

string

[Full-projection-only] Email address of the user who ran the job.

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.

Try it!

หน้านี้มีประโยชน์ไหม โปรดแสดงความคิดเห็น