Post v1projectsprojectinstancesinstancestartexternalsync

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1375137252.2 KB

projects

Start External primary instance migration.

post/v1/projects/{project}/instances/{instance}/startExternalSync

Path parameters

projectstring required

ID of the project that contains the instance.

instancestring required

Cloud SQL instance ID. This does not include the project ID.

Request body

replicaOverwriteEnabledboolean

Optional. MySQL only. True if end-user has confirmed that this SES call will wipe replica databases overlapping with the proposed selected_objects. If this field is not set and there are both overlapping and additional databases proposed, an error will be returned.

syncMode'EXTERNAL_SYNC_MODE_UNSPECIFIED' | 'ONLINE' | 'OFFLINE'

External sync mode.

skipVerificationboolean

Whether to skip the verification step (VESS).

migrationType'MIGRATION_TYPE_UNSPECIFIED' | 'LOGICAL' | 'PHYSICAL'

Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are LOGICAL or PHYSICAL. Only applicable to MySQL.

syncParallelLevel'EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED' | 'MIN' | 'OPTIMAL' | 'MAX'

Optional. Parallel level for initial data sync. Currently only applicable for MySQL.

Response

Successful response