Database Migration API

Manage Cloud Database Migration Service resources on Google Cloud Platform.

Service: datamigration.googleapis.com

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://datamigration.googleapis.com

REST Resource: v1beta1.projects.locations

Methods
get GET /v1beta1/{name}
Gets information about a location.
list GET /v1beta1/{name}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta1.projects.locations.connectionProfiles

Methods
create POST /v1beta1/{parent}/connectionProfiles
Creates a new connection profile in a given project and location.
delete DELETE /v1beta1/{name}
Deletes a single Database Migration Service connection profile.
get GET /v1beta1/{name}
Gets details of a single connection profile.
getIamPolicy GET /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1beta1/{parent}/connectionProfiles
Retrieve a list of all connection profiles in a given project and location.
patch PATCH /v1beta1/{connectionProfile.name}
Update the configuration of a single connection profile.
setIamPolicy POST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1beta1.projects.locations.migrationJobs

Methods
create POST /v1beta1/{parent}/migrationJobs
Creates a new migration job in a given project and location.
delete DELETE /v1beta1/{name}
Deletes a single migration job.
generateSshScript POST /v1beta1/{migrationJob}:generateSshScript
Generate a SSH configuration script to configure the reverse SSH connectivity.
get GET /v1beta1/{name}
Gets details of a single migration job.
getIamPolicy GET /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1beta1/{parent}/migrationJobs
Lists migration jobs in a given project and location.
patch PATCH /v1beta1/{migrationJob.name}
Updates the parameters of a single migration job.
promote POST /v1beta1/{name}:promote
Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
restart POST /v1beta1/{name}:restart
Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
resume POST /v1beta1/{name}:resume
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
setIamPolicy POST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
start POST /v1beta1/{name}:start
Start an already created migration job.
stop POST /v1beta1/{name}:stop
Stops a running migration job.
testIamPermissions POST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.
verify POST /v1beta1/{name}:verify
Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

REST Resource: v1beta1.projects.locations.operations

Methods
cancel POST /v1beta1/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1beta1/{name}
Deletes a long-running operation.
get GET /v1beta1/{name}
Gets the latest state of a long-running operation.
list GET /v1beta1/{name}/operations
Lists operations that match the specified filter in the request.

Service: datamigration.googleapis.com

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://datamigration.googleapis.com

REST Resource: v1alpha2.projects.locations

Methods
get GET /v1alpha2/{name}
Gets information about a location.
list GET /v1alpha2/{name}/locations
Lists information about the supported locations for this service.

REST Resource: v1alpha2.projects.locations.connectionProfiles

Methods
create POST /v1alpha2/{parent}/connectionProfiles
Creates a new connection profile in a given project and location.
delete DELETE /v1alpha2/{name}
Deletes a single Database Migration Service connection profile.
get GET /v1alpha2/{name}
Gets details of a single connection profile.
getIamPolicy GET /v1alpha2/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1alpha2/{parent}/connectionProfiles
Retrieve a list of all connection profiles in a given project and location.
patch PATCH /v1alpha2/{connectionProfile.name}
Update the configuration of a single connection profile.
setIamPolicy POST /v1alpha2/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1alpha2/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1alpha2.projects.locations.migrationJobs

Methods
create POST /v1alpha2/{parent}/migrationJobs
Creates a new migration job in a given project and location.
delete DELETE /v1alpha2/{name}
Deletes a single migration job.
generateSshScript POST /v1alpha2/{name}:generateSshScript
Generate a SSH configuration script to configure the reverse SSH connectivity.
get GET /v1alpha2/{name}
Gets details of a single migration job.
getIamPolicy GET /v1alpha2/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1alpha2/{parent}/migrationJobs
Lists migration jobs in a given project and location.
patch PATCH /v1alpha2/{migrationJob.name}
Updates the parameters of a single migration job.
promote POST /v1alpha2/{name}:promote
Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
restart POST /v1alpha2/{name}:restart
Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
resume POST /v1alpha2/{name}:resume
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
setIamPolicy POST /v1alpha2/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
start POST /v1alpha2/{name}:start
Start an already created migration job.
stop POST /v1alpha2/{name}:stop
Stops a running migration job.
testIamPermissions POST /v1alpha2/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.
verify POST /v1alpha2/{name}:verify
Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

REST Resource: v1alpha2.projects.locations.operations

Methods
cancel POST /v1alpha2/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1alpha2/{name}
Deletes a long-running operation.
get GET /v1alpha2/{name}
Gets the latest state of a long-running operation.
list GET /v1alpha2/{name}/operations
Lists operations that match the specified filter in the request.

Service: datamigration.googleapis.com

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://datamigration.googleapis.com

REST Resource: v1.projects.locations

Methods
get GET /v1/{name}
Gets information about a location.
list GET /v1/{name}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.connectionProfiles

Methods
create POST /v1/{parent}/connectionProfiles
Creates a new connection profile in a given project and location.
delete DELETE /v1/{name}
Deletes a single Database Migration Service connection profile.
get GET /v1/{name}
Gets details of a single connection profile.
getIamPolicy GET /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent}/connectionProfiles
Retrieve a list of all connection profiles in a given project and location.
patch PATCH /v1/{connectionProfile.name}
Update the configuration of a single connection profile.
setIamPolicy POST /v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.migrationJobs

Methods
create POST /v1/{parent}/migrationJobs
Creates a new migration job in a given project and location.
delete DELETE /v1/{name}
Deletes a single migration job.
generateSshScript POST /v1/{migrationJob}:generateSshScript
Generate a SSH configuration script to configure the reverse SSH connectivity.
get GET /v1/{name}
Gets details of a single migration job.
getIamPolicy GET /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent}/migrationJobs
Lists migration jobs in a given project and location.
patch PATCH /v1/{migrationJob.name}
Updates the parameters of a single migration job.
promote POST /v1/{name}:promote
Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
restart POST /v1/{name}:restart
Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
resume POST /v1/{name}:resume
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
setIamPolicy POST /v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
start POST /v1/{name}:start
Start an already created migration job.
stop POST /v1/{name}:stop
Stops a running migration job.
testIamPermissions POST /v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.
verify POST /v1/{name}:verify
Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name}
Deletes a long-running operation.
get GET /v1/{name}
Gets the latest state of a long-running operation.
list GET /v1/{name}/operations
Lists operations that match the specified filter in the request.