ConfigureSynchronizationJob - Configure DTS sync instance - Data Transmission Service

Configura una tarea de sincronización de datos.

Llame a CreateSynchronizationJob para crear una instancia de sincronización de datos antes de invocar esta operación.

Nota

Después de la configuración, la tarea se inicia automáticamente y ejecuta una comprobación previa. No es necesario llamar a StartSynchronizationJob.
Si la tarea no se inicia debido a un error en la comprobación previa, llame a DescribeSynchronizationJobStatus para comprobar el error y corregir el problema. A continuación, llame a StartSynchronizationJob para reiniciar la tarea.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Llame a esta operación en OpenAPI Explorer para generar código de ejemplo para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ConfigureSynchronizationJob	La operación que se va a ejecutar. Establezca este valor en ConfigureSynchronizationJob.
DataInitialization	Boolean	Sí	true	Indica si se ejecuta la sincronización inicial completa de datos. Valores válidos: true: sí false: no Nota Valor predeterminado: true.
StructureInitialization	Boolean	Sí	true	Indica si se ejecuta la sincronización inicial del esquema. Valores válidos: true: sí false: no Nota Valor predeterminado: true.
SynchronizationJobId	String	Sí	dtsz4ao1dor13d****	El ID de la instancia de sincronización de datos. Llame a DescribeSynchronizationJobs para consultar los ID de las instancias.
SynchronizationObjects	String	Sí	[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]	Los objetos que se van a sincronizar. El valor es una cadena JSON compatible con expresiones regulares. SynchronizationObjects.
RegionId	String	No	cn-hangzhou	El ID de la región de la instancia de sincronización de datos. Lista de regiones compatibles.
SynchronizationJobName	String	No	MySQL Synchronization	El nombre de la tarea de sincronización de datos. Nota Utilice un nombre descriptivo para facilitar su identificación. No es obligatorio que sea único.
SynchronizationDirection	String	No	Forward	La dirección de la sincronización. Valores válidos: Forward Reverse Nota Valor predeterminado: Forward. El valor Reverse solo surte efecto si la topología de la instancia de sincronización de datos es de sincronización bidireccional.
SourceEndpoint.InstanceId	String	No	rm-bp1i99e8l7913****	El ID de la instancia de origen.
SourceEndpoint.InstanceType	String	No	RDS	El tipo de la instancia de origen. Valores válidos: RDS: instancia de ApsaraDB RDS Redis: instancia de ApsaraDB for Redis PolarDB: clúster de PolarDB for MySQL o clúster de PolarDB O Edition ECS: base de datos autogestionada alojada en Elastic Compute Service (ECS) Express: base de datos autogestionada conectada mediante Express Connect dg: base de datos autogestionada conectada mediante Database Gateway cen: base de datos autogestionada conectada mediante Cloud Enterprise Network (CEN) Nota El valor predeterminado es RDS.
SourceEndpoint.IP	String	No	172.16.88.***	La dirección IP de la base de datos de origen. Nota Solo debe especificar este parámetro si el parámetro SourceEndpoint.InstanceType se establece en ECS, Express, dg o cen.
SourceEndpoint.Port	String	No	3306	El número de puerto de servicio de la base de datos de origen. Nota Solo debe especificar este parámetro si el parámetro SourceEndpoint.InstanceType se establece en ECS, Express, dg o cen.
SourceEndpoint.UserName	String	No	dtstestaccount	La cuenta de la base de datos de origen. Nota Solo debe especificar este parámetro si el parámetro SourceEndpoint.InstanceType se establece en ECS, Express, dg o cen. Si el parámetro SourceEndpoint.InstanceType se establece en Redis, no es necesario especificar la cuenta de la base de datos. Los permisos obligatorios varían según el escenario de sincronización. Descripción general de los escenarios de sincronización de datos.
SourceEndpoint.Password	String	No	Test123456	La contraseña de la cuenta de la base de datos de origen. Nota Solo debe especificar este parámetro si el parámetro SourceEndpoint.InstanceType se establece en ECS, Express, dg o cen.
DestinationEndpoint.InstanceId	String	No	rm-bp1r46452ai50****	El ID de la instancia de destino. Nota Si el parámetro DestinationEndpoint.InstanceType se establece en MaxCompute o DataHub, debe especificar el nombre del proyecto de MaxCompute o del proyecto de DataHub. Si la instancia de destino es un clúster de AnalyticDB for MySQL, especifique el ID de dicho clúster.
DestinationEndpoint.InstanceType	String	No	RDS	El tipo de la instancia de destino. Valores válidos: Redis: instancia de ApsaraDB for Redis RDS: instancia de ApsaraDB RDS PolarDB: clúster de PolarDB for MySQL o clúster de PolarDB O Edition ECS: base de datos autogestionada alojada en ECS Express: base de datos autogestionada conectada mediante Express Connect DataHub: proyecto de DataHub MaxCompute: proyecto de MaxCompute AnalyticDB: clúster de AnalyticDB for MySQL V3.0 o V2.0 Greenplum: instancia de AnalyticDB for PostgreSQL Nota El valor predeterminado es RDS.
DestinationEndpoint.IP	String	No	172.16.88.***	La dirección IP de la base de datos de destino. Nota Solo debe especificar este parámetro si el parámetro DestinationEndpoint.InstanceType se establece en Express, dg o cen.
DestinationEndpoint.Port	String	No	3306	El número de puerto de servicio de la base de datos de destino. Nota Solo debe especificar este parámetro si el parámetro DestinationEndpoint.InstanceType se establece en ECS, Express, dg o cen.
DestinationEndpoint.UserName	String	No	dtstestaccount	La cuenta de la base de datos de destino. Nota Los permisos obligatorios varían según el escenario de sincronización. Descripción general de los escenarios de sincronización de datos. Si el parámetro DestinationEndpoint.InstanceType se establece en ECS, Express, dg o cen, debe especificar el parámetro DestinationEndpoint.UserName. Si el parámetro DestinationEndpoint.InstanceType se establece en RDS y la versión de la base de datos es MySQL 5.5 o MySQL 5.6, no es necesario especificar los parámetros DestinationEndpoint.UserName y DestinationEndpoint.Password. Si el parámetro DestinationEndpoint.InstanceType se establece en Redis, no es necesario especificar el parámetro DestinationEndpoint.UserName.
DestinationEndpoint.Password	String	No	Test654321	La contraseña de la cuenta de la base de datos de destino. Nota Si el parámetro DestinationEndpoint.InstanceType se establece en ECS, Express, dg o cen, debe especificar el parámetro DestinationEndpoint.Password.
SourceEndpoint.OwnerID	String	No	140692647406****	El ID de la cuenta de Alibaba Cloud del propietario de la instancia de RDS de origen. Nota Obligatorio para la sincronización entre cuentas. También debe especificar SourceEndpoint.Role.
SourceEndpoint.Role	String	No	ram-for-dts	El nombre del rol de RAM configurado para la cuenta de Alibaba Cloud propietaria de la instancia de origen. Nota Obligatorio para la sincronización entre cuentas. Configurar la autorización de RAM para la migración y sincronización de datos entre cuentas.
PartitionKey.ModifyTime_Year	Boolean	No	true	Indica si la tabla de datos incrementales contiene particiones definidas por el campo modifytime_year. Valores válidos: true y false. Nota Este parámetro solo está disponible si el parámetro DestinationEndpoint.InstanceType se establece en MaxCompute.
PartitionKey.ModifyTime_Month	Boolean	No	true	Indica si la tabla de datos incrementales contiene particiones definidas por el campo modifytime_month. Valores válidos: true y false. Nota Este parámetro solo está disponible si el parámetro DestinationEndpoint.InstanceType se establece en MaxCompute.
PartitionKey.ModifyTime_Day	Boolean	No	true	Indica si la tabla de datos incrementales contiene particiones definidas por el campo modifytime_day. Valores válidos: true y false. Nota Este parámetro solo está disponible si el parámetro DestinationEndpoint.InstanceType se establece en MaxCompute.
PartitionKey.ModifyTime_Hour	Boolean	No	true	Indica si la tabla de datos incrementales contiene particiones definidas por el campo modifytime_hour. Valores válidos: true y false. Nota Este parámetro solo está disponible si el parámetro DestinationEndpoint.InstanceType se establece en MaxCompute.
PartitionKey.ModifyTime_Minute	Boolean	No	true	Indica si la tabla de datos incrementales contiene particiones definidas por el campo modifytime_minute. Valores válidos: true y false. Nota Este parámetro solo está disponible si el parámetro DestinationEndpoint.InstanceType se establece en MaxCompute.
MigrationReserved	String	No	{ "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }	El parámetro reservado de DTS. Es una cadena JSON para requisitos especiales, como indicar si se inicia automáticamente una comprobación previa. MigrationReserved. Nota También se utiliza para la sincronización de datos entre instancias de ApsaraDB for Redis Enterprise Edition. Usar OpenAPI Explorer para configurar la sincronización de datos unidireccional o bidireccional entre instancias de ApsaraDB for Redis Enterprise Edition.
Checkpoint	String	No	1610540493	El punto de control de la sincronización.
AccountId	String	No	12323344****	El ID de la cuenta de Alibaba Cloud. Este parámetro está obsoleto y se eliminará en una versión futura.
SourceEndpoint.DatabaseName	String	No	dtstestdata	El nombre de la base de datos a la que pertenece el objeto de sincronización en la instancia de origen.
DestinationEndpoint.DataBaseName	String	No	dtstestdata	El nombre de la base de datos a la que pertenece el objeto de sincronización en la instancia de destino.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
ErrCode	String	InternalError	El código de error devuelto si la solicitud presenta errores.
ErrMessage	String	The request processing has failed due to some unknown error.	El mensaje de error devuelto si la solicitud presenta errores.
RequestId	String	2690E467-7773-43BC-A009-370EE2E7****	El ID de la solicitud.
Success	String	true	Indica si la solicitud fue exitosa.

Ejemplos

Ejemplos de solicitudes

http(s)://dts.aliyuncs.com/?Action=ConfigureSynchronizationJob
&DataInitialization=true
&StructureInitialization=true
&SynchronizationJobId=dtsz4ao1dor13d****
&SynchronizationObjects=[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]
&<Common request parameters>

Ejemplos de respuestas exitosas

Formato XML

<ConfigureSynchronizationJobResponse>
      <RequestId>2690E467-7773-43BC-A009-370EE2E7****</RequestId>
      <Success>true</Success>
</ConfigureSynchronizationJobResponse>

Formato JSON

{
    "RequestId": "2690E467-7773-43BC-A009-370EE2E7****",
    "Success": true
}

Códigos de error

Para consultar la lista de códigos de error, visite el Centro de errores de API.