Todos os produtos
Search
Central de documentação

Data Transmission Service:ConfigureMigrationJob

Última atualização: Jun 27, 2026

Configura uma tarefa de migração de dados.

Após a chamada desta operação para configurar uma tarefa de migração de dados, a tarefa inicia automaticamente. Não é necessário chamar a operação StartMigrationJob para iniciar a tarefa.

A tarefa de migração de dados pode falhar ao iniciar devido a erros na pré-verificação. Chame a operação DescribeMigrationJobStatus para consultar as mensagens de erro sobre as falhas na pré-verificação. Corrija o problema com base nessas mensagens. Após a correção, chame a operação StartMigrationJob para reiniciar a tarefa de migração de dados.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

ParâmetroTipoObrigatórioExemploDescrição
ActionStringSimConfigureMigrationJob

A operação a ser executada. Defina o valor como ConfigureMigrationJob.

DestinationEndpoint.InstanceTypeStringSimRDS

O tipo de instância do banco de dados de destino. Valores válidos:

  • ECS: banco de dados autogerenciado hospedado no Elastic Compute Service (ECS)
  • LocalInstance: banco de dados autogerenciado com endereço IP público
  • RDS: instância do ApsaraDB RDS
  • DRDS: instância do PolarDB-X
  • MongoDB: instância do ApsaraDB for MongoDB
  • Redis: instância do ApsaraDB for Redis
  • PetaData: instância do HybridDB for MySQL
  • POLARDB: cluster do PolarDB for MySQL ou cluster do PolarDB for PostgreSQL
  • PolarDB_o: cluster do PolarDB O Edition
  • AnalyticDB: cluster do AnalyticDB for MySQL V3.0 ou V2.0
  • Greenplum: instância do AnalyticDB for PostgreSQL
MigrationJobIdStringSimdtsl3m1213ye7l****

O ID da instância de migração de dados. Chame a operação DescribeMigrationJobs para consultar o ID da instância.

MigrationJobNameStringSimMySQL_TO_RDS

O nome da tarefa de migração de dados. O nome pode ter até 32 caracteres. Recomendamos especificar um nome informativo para identificar a tarefa. Não é necessário usar um nome exclusivo.

MigrationMode.DataIntializationBooleanSimtrue

Define se a migração completa de dados deve ser executada. Valores válidos:

  • true: sim
  • false: não
Nota Para obter mais informações sobre bancos de dados compatíveis com migração completa de dados, consulte Bancos de dados e tipos de migração suportados.
MigrationMode.DataSynchronizationBooleanSimtrue

Define se a migração incremental de dados deve ser executada. Valores válidos:

  • true: sim
  • false: não
Nota Para obter mais informações sobre bancos de dados compatíveis com migração incremental de dados, consulte Bancos de dados e tipos de migração suportados.
MigrationMode.StructureIntializationBooleanSimtrue

Define se a migração de esquema deve ser executada. Valores válidos:

  • true: sim
  • false: não
Nota Para obter mais informações sobre bancos de dados compatíveis com migração de esquema, consulte Bancos de dados e tipos de migração suportados.
MigrationObjectStringSim[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]

Os objetos a serem migrados. O valor é uma string JSON e pode conter expressões regulares.

Para obter mais informações, consulte MigrationObject.

SourceEndpoint.InstanceTypeStringSimRDS

O tipo de instância do banco de dados de source. Valores válidos:

  • RDS: instância do ApsaraDB RDS
  • ECS: banco de dados autogerenciado hospedado no ECS
  • LocalInstance: banco de dados autogerenciado com endereço IP público
  • Express: banco de dados autogerenciado conectado via Express Connect, VPN Gateway ou Smart Access Gateway
  • dg: banco de dados autogerenciado conectado via Database Gateway
  • cen: banco de dados autogerenciado conectado via Cloud Enterprise Network (CEN)
  • MongoDB: instância do ApsaraDB for MongoDB
  • POLARDB: cluster do PolarDB for MySQL ou cluster do PolarDB for PostgreSQL
  • PolarDB_o: cluster do PolarDB O Edition
RegionIdStringNãocn-hangzhou

O ID da região onde a instância de migração de dados reside. Para obter mais informações, consulte Lista de regiões suportadas.

Nota O ID da região da instância de migração de dados é o mesmo do banco de dados de destino.
SourceEndpoint.InstanceIDStringNãorm-bp1i99e8l7913****

O ID da instância que hospeda o banco de dados de source.

Nota
  • Especifique o ID da instância apenas se o parâmetro SourceEndpoint.InstanceType estiver definido como RDS, ECS, Express, MongoDB, POLARDB ou PolarDB_o. Por exemplo, se o parâmetro SourceEndpoint.InstanceType estiver definido como ECS, especifique o ID da instância ECS.
  • Se o parâmetro SourceEndpoint.InstanceType estiver definido como Express, especifique o ID da virtual private cloud (VPC).
SourceEndpoint.EngineNameStringNãoMySQL

O tipo de mecanismo do banco de dados de source. Valores válidos: MySQL, TiDB, SQLServer, PostgreSQL, Oracle, MongoDB, Redis, POLARDB e polardb_pg.

Nota Especifique o tipo de mecanismo apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como RDS, POLARDB, ECS, LocalInstance ou Express.
SourceEndpoint.RegionStringNãocn-hangzhou

O ID da região do banco de dados de source.

Nota Se o parâmetro SourceEndpoint.InstanceType estiver definido como LocalInstance, insira cn-hangzhou ou o ID da região mais próxima do banco de dados autogerenciado. Para obter mais informações, consulte Lista de regiões suportadas.
SourceEndpoint.IPStringNão172.16.88.***

O endpoint do banco de dados de source.

Nota Especifique o endpoint apenas se o parâmetro SourceEndpoint.InstanceType estiver definido como LocalInstance ou Express.
SourceEndpoint.PortStringNão3306

O número da porta de serviço do banco de dados de source.

Nota Especifique o número da porta de serviço apenas se o parâmetro SourceEndpoint.InstanceType estiver definido como ECS, LocalInstance ou Express.
SourceEndpoint.OracleSIDStringNãotestsid

O ID do sistema (SID) do banco de dados Oracle.

Nota Especifique este parâmetro apenas se o parâmetro SourceEndpoint.EngineName estiver definido como Oracle e o banco de dados Oracle estiver implantado em uma arquitetura não RAC.
SourceEndpoint.DatabaseNameStringNãodtstestdatabase

O nome do banco de dados de source ou do banco de dados de autenticação.

Nota
  • Especifique o nome do banco de dados apenas se o parâmetro SourceEndpoint.EngineName estiver definido como PostgreSQL ou MongoDB.
  • Se o parâmetro SourceEndpoint.EngineName estiver definido como PostgreSQL, especifique o nome do banco de dados de source. Se o parâmetro SourceEndpoint.EngineName estiver definido como MongoDB, especifique o nome do banco de dados de autenticação.
SourceEndpoint.UserNameStringNãodtstestaccount

A conta do banco de dados de source.

Nota As permissões necessárias para as contas de banco de dados variam conforme o cenário de migração. Para obter mais informações, consulte Visão geral dos cenários de migração de dados.
SourceEndpoint.PasswordStringNãoTest123456

A senha da conta do banco de dados de source.

SourceEndpoint.OwnerIDStringNão140692647406****

O ID da conta Alibaba Cloud à qual a instância de source pertence.

Nota Especifique este parâmetro apenas ao configurar a migração de dados entre diferentes contas Alibaba Cloud.
SourceEndpoint.RoleStringNãoram-for-dts

A função RAM autorizada da instância de source. Especifique a função RAM apenas se a instância de source e a instância de destino pertencerem a diferentes contas Alibaba Cloud. Use a função RAM para permitir que a conta Alibaba Cloud proprietária da instância de destino acesse a instância de source.

Nota Para obter informações sobre as permissões e métodos de autorização da função RAM, consulte Configurar autorização RAM para migração e sincronização de dados entre contas.
DestinationEndpoint.InstanceIDStringNãorm-bp1r46452ai50****

O ID da instância que hospeda o banco de dados de destino.

Nota Especifique o ID da instância apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como RDS, ECS, MongoDB, Redis, DRDS, PetaData, OceanBase, POLARDB, PolarDB_o, AnalyticDB ou Greenplum. Por exemplo, se o parâmetro DestinationEndpoint.InstanceType estiver definido como ECS, especifique o ID da instância ECS.
DestinationEndpoint.EngineNameStringNãoMySQL

O tipo de mecanismo do banco de dados de destino. Valores válidos: MySQL, DRDS, SQLServer, PostgreSQL, PPAS, MongoDB, Redis, POLARDB e polardb_pg.

Nota Especifique o tipo de mecanismo apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como RDS, POLARDB, ECS, LocalInstance ou Express.
DestinationEndpoint.RegionStringNãocn-hangzhou

O ID da região do banco de dados de destino.

Nota Se o parâmetro DestinationEndpoint.InstanceType estiver definido como LocalInstance, insira cn-hangzhou ou o ID da região mais próxima do banco de dados autogerenciado. Para obter mais informações, consulte Lista de regiões suportadas.
DestinationEndpoint.IPStringNão172.16.88.***

O endpoint do banco de dados de destino.

Nota Especifique o endpoint apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como LocalInstance ou Express.
DestinationEndpoint.PortStringNão3306

O número da porta de serviço do banco de dados de destino.

Nota Especifique o número da porta de serviço apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como ECS, LocalInstance ou Express.
DestinationEndpoint.DataBaseNameStringNãodtstestdatabase

O nome do banco de dados de destino ou do banco de dados de autenticação.

Nota
  • Especifique o nome do banco de dados apenas se o parâmetro DestinationEndpoint.EngineName estiver definido como PostgreSQL, DRDS ou MongoDB.
  • Se o parâmetro DestinationEndpoint.EngineName estiver definido como PostgreSQL ou DRDS, especifique o nome do banco de dados de destino. Se o parâmetro DestinationEndpoint.EngineName estiver definido como MongoDB, especifique o nome do banco de dados de autenticação.
DestinationEndpoint.UserNameStringNãodtstestaccount

A conta do banco de dados de destino.

Nota As permissões necessárias para as contas de banco de dados variam conforme o cenário de migração. Para obter mais informações, consulte Visão geral dos cenários de migração de dados.
DestinationEndpoint.PasswordStringNãoTest123456

A senha da conta do banco de dados de destino.

MigrationReservedStringNão{ "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }

O parâmetro reservado do DTS. O valor é uma string JSON. Especifique este parâmetro para atender a requisitos especiais, por exemplo, definir se uma pré-verificação deve ser iniciada automaticamente. Para obter mais informações, consulte MigrationReserved.

CheckpointStringNão111

O deslocamento inicial da migração incremental de dados. O valor é um carimbo de data/hora UNIX. Unidade: segundos.

AccountIdStringNão12323344****

O ID da conta Alibaba Cloud. Não é necessário especificar este parâmetro, pois ele será removido futuramente.

DestinationEndpoint.OracleSIDStringNãotestsid

O SID do banco de dados Oracle.

Nota Especifique este parâmetro apenas se o parâmetro DestinationEndpoint.EngineName estiver definido como Oracle e o banco de dados Oracle estiver implantado em uma arquitetura não RAC.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

ErrCode

String

InternalError

O código de erro retornado se a chamada falhar.

ErrMessage

String

The request processing has failed due to some unknown error.

A mensagem de erro retornada se a chamada falhar.

RequestId

String

40E35BD9-002E-4D63-9BE5-FBA48833****

O ID da solicitação.

Success

String

true

Indica se a chamada foi bem-sucedida.

Exemplos

Exemplos de solicitações

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>

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.