ConfigureMigrationJob - Data Transmission Service - Centro de documentación de Alibaba Cloud

Configure una tarea de migración de datos.

Después de llamar a esta operación para configurar una tarea de migración de datos, la tarea se inicia automáticamente. No es necesario llamar a la operación StartMigrationJob para iniciarla.

Es posible que una tarea de migración de datos no se inicie debido a errores en la verificación previa. Llame a la operación DescribeMigrationJobStatus para consultar los mensajes de error sobre los fallos de la verificación previa. Posteriormente, solucione el problema basándose en dichos mensajes. Una vez corregido el problema, debe llamar a la operación StartMigrationJob para reiniciar la tarea de migración de datos.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ConfigureMigrationJob	La operación que desea ejecutar. Establezca el valor en ConfigureMigrationJob.
DestinationEndpoint.InstanceType	String	Sí	RDS	El tipo de instancia de la base de datos de destino. Valores válidos: ECS: base de datos autogestionada alojada en Elastic Compute Service (ECS) LocalInstance: base de datos autogestionada con una dirección IP pública RDS: instancia de ApsaraDB RDS DRDS: instancia de PolarDB-X MongoDB: instancia de ApsaraDB for MongoDB Redis: instancia de ApsaraDB for Redis PetaData: instancia de HybridDB for MySQL POLARDB: clúster de PolarDB for MySQL o clúster de PolarDB for PostgreSQL PolarDB_o: clúster de PolarDB O Edition AnalyticDB: clúster de AnalyticDB for MySQL V3.0 o V2.0 Greenplum: instancia de AnalyticDB for PostgreSQL
MigrationJobId	String	Sí	dtsl3m1213ye7l****	El ID de la instancia de migración de datos. Puede llamar a la operación DescribeMigrationJobs para consultar el ID de la instancia.
MigrationJobName	String	Sí	MySQL_TO_RDS	El nombre de la tarea de migración de datos. El nombre puede tener hasta 32 caracteres. Se recomienda especificar un nombre descriptivo para identificar la tarea. No es necesario utilizar un nombre único.
MigrationMode.DataIntialization	Boolean	Sí	true	Especifica si se debe realizar la migración completa de datos. Valores válidos: true: sí false: no Nota Para obtener más información sobre las bases de datos compatibles con la migración completa de datos, consulte Bases de datos y tipos de migración compatibles.
MigrationMode.DataSynchronization	Boolean	Sí	true	Especifica si se debe realizar la migración incremental de datos. Valores válidos: true: sí false: no Nota Para obtener más información sobre las bases de datos compatibles con la migración incremental de datos, consulte Bases de datos y tipos de migración compatibles.
MigrationMode.StructureIntialization	Boolean	Sí	true	Especifica si se debe realizar la migración de esquema. Valores válidos: true: sí false: no Nota Para obtener más información sobre las bases de datos compatibles con la migración de esquema, consulte Bases de datos y tipos de migración compatibles.
MigrationObject	String	Sí	[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]	Los objetos que desea migrar. El valor es una cadena JSON y puede contener expresiones regulares. Para obtener más información, consulte MigrationObject.
SourceEndpoint.InstanceType	String	Sí	RDS	El tipo de instancia de la base de datos de origen. Valores válidos: RDS: instancia de ApsaraDB RDS ECS: base de datos autogestionada alojada en ECS LocalInstance: base de datos autogestionada con una dirección IP pública Express: base de datos autogestionada conectada mediante Express Connect, VPN Gateway o Smart Access Gateway dg: base de datos autogestionada conectada mediante Database Gateway cen: base de datos autogestionada conectada mediante Cloud Enterprise Network (CEN) MongoDB: instancia de ApsaraDB for MongoDB POLARDB: clúster de PolarDB for MySQL o clúster de PolarDB for PostgreSQL PolarDB_o: clúster de PolarDB O Edition
RegionId	String	No	cn-hangzhou	El ID de la región donde reside la instancia de migración de datos. Para obtener más información, consulte Lista de regiones compatibles. Nota El ID de región de la instancia de migración de datos es el mismo que el de la base de datos de destino.
SourceEndpoint.InstanceID	String	No	rm-bp1i99e8l7913****	El ID de la instancia que aloja la base de datos de origen. Nota Debe especificar el ID de la instancia únicamente si el parámetro SourceEndpoint.InstanceType está establecido en RDS, ECS, Express, MongoDB, POLARDB o PolarDB_o. Por ejemplo, si el parámetro SourceEndpoint.InstanceType está establecido en ECS, debe especificar el ID de la instancia de ECS. Si el parámetro SourceEndpoint.InstanceType está establecido en Express, debe especificar el ID de la virtual private cloud (VPC).
SourceEndpoint.EngineName	String	No	MySQL	El tipo de motor de la base de datos de origen. Valores válidos: MySQL, TiDB, SQLServer, PostgreSQL, Oracle, MongoDB, Redis, POLARDB y polardb_pg. Nota Debe especificar el tipo de motor únicamente si el parámetro DestinationEndpoint.InstanceType está establecido en RDS, POLARDB, ECS, LocalInstance o Express.
SourceEndpoint.Region	String	No	cn-hangzhou	El ID de región de la base de datos de origen. Nota Si el parámetro SourceEndpoint.InstanceType está establecido en LocalInstance, puede introducir cn-hangzhou o el ID de la región más cercana a la base de datos autogestionada. Para obtener más información, consulte Lista de regiones compatibles.
SourceEndpoint.IP	String	No	172.16.88.***	El endpoint de la base de datos de origen. Nota Debe especificar el endpoint únicamente si el parámetro SourceEndpoint.InstanceType está establecido en LocalInstance o Express.
SourceEndpoint.Port	String	No	3306	El número de puerto de servicio de la base de datos de origen. Nota Debe especificar el número de puerto de servicio únicamente si el parámetro SourceEndpoint.InstanceType está establecido en ECS, LocalInstance o Express.
SourceEndpoint.OracleSID	String	No	testsid	El ID del sistema (SID) de la base de datos Oracle. Nota Debe especificar este parámetro únicamente si el parámetro SourceEndpoint.EngineName está establecido en Oracle y la base de datos Oracle está implementada en una arquitectura sin RAC.
SourceEndpoint.DatabaseName	String	No	dtstestdatabase	El nombre de la base de datos de origen o de la base de datos de autenticación. Nota Debe especificar el nombre de la base de datos únicamente si el parámetro SourceEndpoint.EngineName está establecido en PostgreSQL o MongoDB. Si el parámetro SourceEndpoint.EngineName está establecido en PostgreSQL, especifique el nombre de la base de datos de origen. Si el parámetro SourceEndpoint.EngineName está establecido en MongoDB, especifique el nombre de la base de datos de autenticación.
SourceEndpoint.UserName	String	No	dtstestaccount	La cuenta de la base de datos de origen. Nota Los permisos necesarios para las cuentas de base de datos varían según el escenario de migración. Para obtener más información, consulte Descripción general de los escenarios de migración de datos.
SourceEndpoint.Password	String	No	Test123456	La contraseña de la cuenta de la base de datos de origen.
SourceEndpoint.OwnerID	String	No	140692647406****	El ID de la cuenta de Alibaba Cloud a la que pertenece la instancia de origen. Nota Debe especificar este parámetro únicamente cuando configure una migración de datos entre diferentes cuentas de Alibaba Cloud.
SourceEndpoint.Role	String	No	ram-for-dts	El rol de RAM autorizado de la instancia de origen. Debe especificar el rol de RAM únicamente si la instancia de origen y la instancia de destino pertenecen a diferentes cuentas de Alibaba Cloud. Puede utilizar el rol de RAM para permitir que la cuenta de Alibaba Cloud propietaria de la instancia de destino acceda a la instancia de origen. Nota Para obtener información sobre los permisos y los métodos de autorización del rol de RAM, consulte Configurar la autorización de RAM para la migración y sincronización de datos entre cuentas.
DestinationEndpoint.InstanceID	String	No	rm-bp1r46452ai50****	El ID de la instancia que aloja la base de datos de destino. Nota Debe especificar el ID de la instancia únicamente si el parámetro DestinationEndpoint.InstanceType está establecido en RDS, ECS, MongoDB, Redis, DRDS, PetaData, OceanBase, POLARDB, PolarDB_o, AnalyticDB o Greenplum. Por ejemplo, si el parámetro DestinationEndpoint.InstanceType está establecido en ECS, debe especificar el ID de la instancia de ECS.
DestinationEndpoint.EngineName	String	No	MySQL	El tipo de motor de la base de datos de destino. Valores válidos: MySQL, DRDS, SQLServer, PostgreSQL, PPAS, MongoDB, Redis, POLARDB y polardb_pg. Nota Debe especificar el tipo de motor únicamente si el parámetro DestinationEndpoint.InstanceType está establecido en RDS, POLARDB, ECS, LocalInstance o Express.
DestinationEndpoint.Region	String	No	cn-hangzhou	El ID de región de la base de datos de destino. Nota Si el parámetro DestinationEndpoint.InstanceType está establecido en LocalInstance, puede introducir cn-hangzhou o el ID de la región más cercana a la base de datos autogestionada. Para obtener más información, consulte Lista de regiones compatibles.
DestinationEndpoint.IP	String	No	172.16.88.***	El endpoint de la base de datos de destino. Nota Debe especificar el endpoint únicamente si el parámetro DestinationEndpoint.InstanceType está establecido en LocalInstance o Express.
DestinationEndpoint.Port	String	No	3306	El número de puerto de servicio de la base de datos de destino. Nota Debe especificar el número de puerto de servicio únicamente si el parámetro DestinationEndpoint.InstanceType está establecido en ECS, LocalInstance o Express.
DestinationEndpoint.DataBaseName	String	No	dtstestdatabase	El nombre de la base de datos de destino o de la base de datos de autenticación. Nota Debe especificar el nombre de la base de datos únicamente si el parámetro DestinationEndpoint.EngineName está establecido en PostgreSQL, DRDS o MongoDB. Si el parámetro DestinationEndpoint.EngineName está establecido en PostgreSQL o DRDS, especifique el nombre de la base de datos de destino. Si el parámetro DestinationEndpoint.EngineName está establecido en MongoDB, especifique el nombre de la base de datos de autenticación.
DestinationEndpoint.UserName	String	No	dtstestaccount	La cuenta de la base de datos de destino. Nota Los permisos necesarios para las cuentas de base de datos varían según el escenario de migración. Para obtener más información, consulte Descripción general de los escenarios de migración de datos.
DestinationEndpoint.Password	String	No	Test123456	La contraseña de la cuenta de la base de datos de destino.
MigrationReserved	String	No	{ "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }	El parámetro reservado de DTS. El valor es una cadena JSON. Puede especificar este parámetro para cumplir requisitos especiales; por ejemplo, si se debe iniciar automáticamente una verificación previa. Para obtener más información, consulte MigrationReserved.
Checkpoint	String	No	111	El desplazamiento inicial de la migración incremental de datos. El valor es una marca de tiempo UNIX. Unidad: segundos.
AccountId	String	No	12323344****	El ID de la cuenta de Alibaba Cloud. No necesita especificar este parámetro porque se eliminará en el futuro.
DestinationEndpoint.OracleSID	String	No	testsid	El SID de la base de datos Oracle. Nota Debe especificar este parámetro únicamente si el parámetro DestinationEndpoint.EngineName está establecido en Oracle y la base de datos Oracle está implementada en una arquitectura sin RAC.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
ErrCode	String	InternalError	El código de error devuelto si la llamada falla.
ErrMessage	String	The request processing has failed due to some unknown error.	El mensaje de error devuelto si la llamada falla.
RequestId	String	40E35BD9-002E-4D63-9BE5-FBA48833****	El ID de la solicitud.
Success	String	true	Indica si la llamada se realizó correctamente.

Ejemplos

Solicitudes de ejemplo

http(s)://dts.aliyuncs.com/?Action=ConfigureMigrationJob
&DestinationEndpoint.InstanceType=RDS
&MigrationJobId=dtsl3m1213ye7l****
&MigrationJobName=MySQL_TO_RDS
&MigrationMode.DataIntialization=true
&MigrationMode.DataSynchronization=true
&MigrationMode.StructureIntialization=true
&MigrationObject=[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]
&SourceEndpoint.InstanceType=RDS
&<Common request parameters>

Respuestas de éxito de ejemplo

Formato XML

<ConfigureMigrationJobResponse>
      <RequestId>40E35BD9-002E-4D63-9BE5-FBA48833****</RequestId>
      <Success>true</Success>
</ConfigureMigrationJobResponse>

Formato JSON

{
    "RequestId": "40E35BD9-002E-4D63-9BE5-FBA48833****",
    "Success": true
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.