Method: projects.locations.modelDeploymentMonitoringJobs.list

Lists ModelDeploymentMonitoringJobs in a Location.

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/modelDeploymentMonitoringJobs

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

Path parameters

Parameters
parent

string

Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

The standard list filter.

Supported fields:

  • displayName supports =, != comparisons, and : wildcard.
  • state supports =, != comparisons.
  • createTime supports =, !=,<, <=,>, >= comparisons. createTime must be in RFC 3339 format.
  • labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence

Some examples of using the filter are:

  • state="JOB_STATE_SUCCEEDED" AND displayName:"my_job_*"
  • state!="JOB_STATE_FAILED" OR displayName="my_job"
  • NOT displayName="my_job"
  • createTime>"2021-05-18T00:00:00Z"
  • labels.keyA=valueA
  • labels.keyB:*
pageSize

integer

The standard list page size.
pageToken

string

The standard list page token.
readMask

string (FieldMask format)

Mask specifying which fields to read

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body must be empty.

Response body

Response message for JobService.ListModelDeploymentMonitoringJobs.

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

JSON representation 
{
  "modelDeploymentMonitoringJobs": [
    {
      object (ModelDeploymentMonitoringJob)
    }
  ],
  "nextPageToken": string
}
Fields
modelDeploymentMonitoringJobs[]

object (ModelDeploymentMonitoringJob)

A list of ModelDeploymentMonitoringJobs that matches the specified filter in the request.
nextPageToken

string

The standard List next-page token.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.modelDeploymentMonitoringJobs.list

For more information, see the IAM documentation.