Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1341173209.0 KB
projects

Creates a new migration job in a given project and location.

post/v1/{+parent}/migrationJobs

Path parameters

parentstring required

Required. The parent which owns this collection of migration jobs.

Query parameters

migrationJobIdstring

Required. The ID of the instance to create.

requestIdstring

Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Request body

displayNamestring

The migration job display name.

satisfiesPziboolean

Output only. Reserved for future use.

type'TYPE_UNSPECIFIED' | 'ONE_TIME' | 'CONTINUOUS'

Required. The migration job type.

labelsobject

The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

phase'PHASE_UNSPECIFIED' | 'FULL_DUMP' | 'CDC' | 'PROMOTE_IN_PROGRESS' | 'WAITING_FOR_SOURCE_WRITES_TO_STOP' | 'PREPARING_THE_DUMP' | 'READY_FOR_PROMOTE'

Output only. The current migration job phase.

durationstring google-duration

Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

namestring

The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.

endTimestring google-datetime

Output only. If the migration job is completed, the time when it was completed.

dumpPathstring

The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.

createTimestring google-datetime

Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

dumpType'DUMP_TYPE_UNSPECIFIED' | 'LOGICAL' | 'PHYSICAL'

Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.

satisfiesPzsboolean

Output only. Reserved for future use.

staticIpConnectivityStaticIpConnectivity

The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required.

sourcestring

Required. The resource name (URI) of the source connection profile.

destinationstring

Required. The resource name (URI) of the destination connection profile.

state'STATE_UNSPECIFIED' | 'MAINTENANCE' | 'DRAFT' | 'CREATING' | 'NOT_STARTED' | 'RUNNING' | 'FAILED' | 'COMPLETED' | 'DELETING' | 'STOPPING' | 'STOPPED' | 'DELETED' | 'UPDATING' | 'STARTING' | 'RESTARTING' | 'RESUMING'

The current migration job state.

filterstring

This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.

originalMigrationNamestring

Optional. A failback replication pointer to the resource name (URI) of the original migration job.

purpose'PURPOSE_UNSPECIFIED' | 'MIGRATE' | 'FAILBACK'

Output only. Migration job mode. Migration jobs can be standard forward jobs or failback migration jobs.

updateTimestring google-datetime

Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

cmekKeyNamestring

The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]

Response

Successful response