Method: projects.instances.verifyExternalSyncSettings

Verify External primary instance external sync settings.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

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

boolean

Flag to enable verifying connection only
syncMode

enum (ExternalSyncMode)

External sync mode
verifyReplicationOnly

boolean

Optional. Flag to verify settings required by replication setup only
mysqlSyncConfig

object (MySqlSyncConfig)

Optional. MySQL-specific settings for start external sync.

Response body

If successful, the response body contains data with the following structure:

Instance verify external sync settings response.

JSON representation 
{
  "kind": string,
  "errors": [
    {
      object (SqlExternalSyncSettingError)
    }
  ],
  "warnings": [
    {
      object (SqlExternalSyncSettingError)
    }
  ]
}
Fields
kind

string

This is always sql#migrationSettingErrorList.
errors[]

object (SqlExternalSyncSettingError)

instances.list of migration violations.
warnings[]

object (SqlExternalSyncSettingError)

instances.list of migration warnings.

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.

SqlExternalSyncSettingError

External primary instance migration setting error/warning.

JSON representation 
{
  "kind": string,
  "type": enum (SqlExternalSyncSettingErrorType),
  "detail": string
}
Fields
kind

string

Can be sql#externalSyncSettingError or sql#externalSyncSettingWarning.
type

enum (SqlExternalSyncSettingErrorType)

Identifies the specific error that occurred.
detail

string

Additional information about the error encountered.

SqlExternalSyncSettingErrorType

Enums
SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED
CONNECTION_FAILURE
BINLOG_NOT_ENABLED
INCOMPATIBLE_DATABASE_VERSION
REPLICA_ALREADY_SETUP
INSUFFICIENT_PRIVILEGE
UNSUPPORTED_MIGRATION_TYPE Unsupported migration type.
NO_PGLOGICAL_INSTALLED No pglogical extension installed on databases, applicable for postgres.
PGLOGICAL_NODE_ALREADY_EXISTS pglogical node already exists on databases, applicable for postgres.
INVALID_WAL_LEVEL The value of parameter wal_level is not set to logical.
INVALID_SHARED_PRELOAD_LIBRARY The value of parameter shared_preload_libraries does not include pglogical.
INSUFFICIENT_MAX_REPLICATION_SLOTS The value of parameter max_replication_slots is not sufficient.
INSUFFICIENT_MAX_WAL_SENDERS The value of parameter max_wal_senders is not sufficient.
INSUFFICIENT_MAX_WORKER_PROCESSES The value of parameter max_worker_processes is not sufficient.
UNSUPPORTED_EXTENSIONS Extensions installed are either not supported or having unsupported versions
INVALID_RDS_LOGICAL_REPLICATION The value of parameter rds.logical_replication is not set to 1.
INVALID_LOGGING_SETUP The primary instance logging setup doesn't allow EM sync.
INVALID_DB_PARAM The primary instance database parameter setup doesn't allow EM sync.
UNSUPPORTED_GTID_MODE The gtid_mode is not supported, applicable for MySQL.
SQLSERVER_AGENT_NOT_RUNNING SQL Server Agent is not running.
UNSUPPORTED_TABLE_DEFINITION The table definition is not support due to missing primary key or replica identity, applicable for postgres.
UNSUPPORTED_DEFINER The customer has a definer that will break EM setup.
SQLSERVER_SERVERNAME_MISMATCH SQL Server @@SERVERNAME does not match actual host name
PRIMARY_ALREADY_SETUP The primary instance has been setup and will fail the setup.
UNSUPPORTED_BINLOG_FORMAT The primary instance has unsupported binary log format.
BINLOG_RETENTION_SETTING The primary instance's binary log retention setting.
UNSUPPORTED_STORAGE_ENGINE The primary instance has tables with unsupported storage engine.