Create Replication Task

Creates a one-way or bidirectional replication task and configures schema replication, full replication, incremental replication, conflict strategy, specification, and object scope.

Request URL: /openapi/v1/replication/create

Request Method: POST

Request Parameters

Parameter	Type	Required	Description	Example
name	String	Yes	Replication task name.	replication_demo
sourceDatasourceType	String	Yes	Source data source type.	mongodb
sourceDatasourceId	String	Yes	Source data source ID. You can query it by calling List Data Sources.	ds-source001
targetDatasourceType	String	Yes	Target data source type.	mongodb
targetDatasourceId	String	Yes	Target data source ID. You can query it by calling List Data Sources.	ds-target001
createType	String	No	Creation mode. See Create Type Values. The default value is one_way.	one_way
existingReplicationId	String	No	Existing replication task ID. Required when createType is bidirectional_from_existing.	rp-deddhxp65zbp
replicationOption	Object	Yes	Replication task options. See replicationOption Fields.	See the example below
objectConfig	Object	Yes	Replication object scope. See objectConfig Fields.	See the example below

replicationOption Fields

Parameter	Type	Required	Description	Example
migrateSchema	Boolean	No	Whether to replicate object schemas. The default value is true.	true
migrateData	Boolean	No	Whether to replicate existing data. The default value is true.	true
incrementalReplication	Boolean	No	Whether to replicate incremental data. The default value is false.	false
specType	String	No	Replication instance specification. See Spec Type Values. The default value is micro.	micro
conflictStrategy	String	Yes	Data or schema conflict handling strategy. See Conflict Strategy Values.	ignore
supportDDL	Boolean	No	Whether DDL replication is supported. The default value is true. For the backward task of bidirectional replication, this value is fixed to false.	true

objectConfig Fields

Parameter	Type	Required	Description	Example
all	Boolean	No	Whether to include all objects in the instance. The default value is false. When set to true, databaseList is not required.	true
databaseList	Array	No	Database object list. Required when all=false. See Database or Schema Object Fields.	See the example below

Database or Schema Object Fields

databaseList and schemaList use the same object structure. For a source with a database-table hierarchy, a databaseList element represents a database. For a source with a database-schema-table hierarchy, a schemaList element represents a schema.

Parameter	Type	Required	Description	Example
all	Boolean	No	Whether to include all child objects under the current database or schema. The default value is false.	false
allTable	Boolean	No	Whether to include all tables. The default value is false.	true
allView	Boolean	No	Whether to include all views. The default value is false.	false
allTrigger	Boolean	No	Whether to include all triggers. The default value is false.	false
allEvent	Boolean	No	Whether to include all events. The default value is false.	false
allFunction	Boolean	No	Whether to include all functions. The default value is false.	false
allProcedure	Boolean	No	Whether to include all procedures. The default value is false.	false
schemaList	Array	No	Schema object list. Use this field for three-level source structures. Elements use the same fields as this table.	See the example below
tableList	Array	No	Specific table object list. Elements use Specified Object Fields.	See the example below
viewList	Array	No	Specific view object list. Elements use Specified Object Fields.	See the example below
functionList	Array	No	Specific function object list. Elements use Specified Object Fields.	See the example below
procedureList	Array	No	Specific procedure object list. Elements use Specified Object Fields.	See the example below
eventList	Array	No	Specific event object list. Elements use Specified Object Fields.	See the example below
triggerList	Array	No	Specific trigger object list. Elements use Specified Object Fields.	See the example below
ddlTriggerList	Array	No	Specific DDL trigger object list. Elements use Specified Object Fields.	See the example below
otherStoredObjectList	Array	No	Other stored object list. Elements use Specified Object Fields.	See the example below

Specified Object Fields

Parameter	Type	Required	Description	Example
databaseName	String	Yes	Source database name.	db1
targetDatabase	String	No	Target database name. Defaults to databaseName.	db1_target
schemaName	String	No	Source schema name. This field can be configured for three-level source structures. The default value is null.	public
targetSchema	String	No	Target schema name. This field can be configured for three-level target structures. The default value is null.	public_target
objectName	String	Yes	Source object name.	table_a
targetName	String	No	Target object name. Defaults to objectName.	table_a_target

Request Example

{
  "name": "replication_demo",
  "sourceDatasourceType": "mongodb",
  "sourceDatasourceId": "ds-source001",
  "targetDatasourceType": "mongodb",
  "targetDatasourceId": "ds-target001",
  "createType": "one_way",
  "replicationOption": {
    "migrateSchema": true,
    "migrateData": true,
    "incrementalReplication": false,
    "specType": "micro",
    "conflictStrategy": "ignore",
    "supportDDL": true
  },
  "objectConfig": {
    "all": true
  }
}

Response Parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request was successful.	true
requestId	String	Request ID.	Oc0a0NWF-BHIAdUBnAEFz4OOdCIt7ANB
data	Object	Creation result.	See the example below
data.replicationId	String	Newly created replication task ID.	rp-div1e4z3z3g3

Successful Invocation Example

{
  "success": true,
  "requestId": "Oc0a0NWF-BHIAdUBnAEFz4OOdCIt7ANB",
  "data": {
    "replicationId": "rp-div1e4z3z3g3"
  }
}

Create Type Values

Value	Description
one_way	Creates a one-way replication task.
bidirectional	Creates both forward and backward tasks to form a bidirectional replication task.
bidirectional_from_existing	Adds a backward task to an existing task to form a bidirectional replication task.

Spec Type Values

micro, small, medium, large, xlarge.

Conflict Strategy Values

Value	Description
ignore	Ignores conflicts.
abort	Stops task execution when a conflict occurs.
replace	Deletes conflicting data and rewrites it. This only applies to full replication.
drop_create	Deletes and recreates conflicting table structures. This only applies to schema replication.