Method: projects.jobs.list

Lists the jobs in the project.

If there are no jobs that match the request parameters, the list request returns an empty response body: {}.

HTTP request

GET https://{endpoint}/v1/{parent=projects/*}/jobs

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the project for which to list jobs.

Authorization requires the following IAM permission on the specified resource parent:

  • ml.jobs.list

Query parameters

Parameters
filter

string

Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census':

gcloud ai-platform jobs list --filter='jobId:census*'

List all failed jobs with names that start with 'rnn':

gcloud ai-platform jobs list --filter='jobId:rnn* AND state:FAILED'

For more examples, see the guide to monitoring jobs.
pageToken

string

Optional. A page token to request the next page of results.

You get the token from the nextPageToken field of the response from the previous call.
pageSize

integer

Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the nextPageToken field.

The default value is 20, and the maximum page size is 100.

Request body

The request body must be empty.

Response body

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

Response message for the jobs.list method.

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

object (Job)

The list of jobs.
nextPageToken

string

Optional. Pass this token as the pageToken field of the request for a subsequent call.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.