Start External primary instance migration.
HTTP request
POST https://sqladmin.googleapis.com/sql/v1beta4/projects/{project}/instances/{instance}/startExternalSync
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project
|
ID of the project that contains the instance. |
instance
|
Cloud SQL instance ID. This does not include the project ID. |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "syncMode" : enum ( |
syncMode
enum (
ExternalSyncMode
)
External sync mode.
skipVerification
boolean
Whether to skip the verification step (VESS).
syncParallelLevel
enum (
ExternalSyncParallelLevel
)
Optional. Parallel level for initial data sync. Currently only applicable for MySQL.
migrationType
enum (
MigrationType
)
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.
replicaOverwriteEnabled
boolean
Optional. MySQL only. True if end-user has confirmed that this SES call will wipe replica databases overlapping with the proposed selectedObjects. If this field is not set and there are both overlapping and additional databases proposed, an error will be returned.
Union field sync_config
.
sync_config
can be only one of the following:
mysqlSyncConfig
object (
MySqlSyncConfig
)
MySQL-specific settings for start external sync.
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/sqlservice.admin
For more information, see the Authentication Overview .
