Method: projects.instances.startExternalSync

Start External primary instance migration.

HTTP request

POST https://sqladmin.googleapis.com/v1/projects/{project}/instances/{instance}/startExternalSync

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

ID of the project that contains the instance.

instance

string

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 (ExternalSyncMode),
  "skipVerification": boolean,
  "mysqlSyncConfig": {
    object (MySqlSyncConfig)
  }
}
Fields
syncMode

enum (ExternalSyncMode)

External sync mode.

skipVerification

boolean

Whether to skip the verification step (VESS).

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.