Method: projects.locations.migrationJobs.list

Lists migration jobs in a given project and location.

HTTP request

GET https://datamigration.googleapis.com/v1alpha2/{parent}/migrationJobs

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of migrationJobs.

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

  • datamigration.migrationjobs.list

Query parameters

Parameters
pageSize

integer

The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.

filter

string

A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.

orderBy

string

Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".

Request body

The request body must be empty.

Response body

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

Response message for 'migrationJobs.list' request.

JSON representation
{
  "migrationJobs": [
    {
      object (MigrationJob)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
migrationJobs[]

object (MigrationJob)

The list of migration jobs objects.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

unreachable[]

string

Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.