Todos os produtos
Search

Este produto

    Data Transmission Service:ConfigureSynchronizationJob

    Central de documentação

    Data Transmission Service:ConfigureSynchronizationJob

    Última atualização: Jun 27, 2026

    Configura uma tarefa de sincronização de dados.

    Chame a operação CreateSynchronizationJob para criar uma instância de sincronização de dados antes de chamar esta operação.

    Nota

    • Após a configuração, a tarefa inicia automaticamente e executa uma pré-verificação. Não é necessário chamar a operação StartSynchronizationJob.

    • Se a tarefa falhar ao iniciar devido a uma falha na pré-verificação, chame a operação DescribeSynchronizationJobStatus para verificar o erro e corrigir o problema. Em seguida, chame a operação StartSynchronizationJob para reiniciar a tarefa.

    Depuração

    O OpenAPI Explorer calcula automaticamente o valor da assinatura. Chame esta operação no OpenAPI Explorer para gerar códigos de exemplo para diferentes SDKs.

    Parâmetros de solicitação

    Parâmetro Tipo Obrigatório Exemplo Descrição
    Action String Sim ConfigureSynchronizationJob

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

    DataInitialization Boolean Sim true

    Indica se a sincronização inicial completa dos dados deve ser realizada. Valores válidos:

    • true: sim
    • false: não
    Nota Valor padrão: true.
    StructureInitialization Boolean Sim true

    Indica se a sincronização inicial do esquema deve ser realizada. Valores válidos:

    • true: sim
    • false: não
    Nota Valor padrão: true.
    SynchronizationJobId String Sim dtsz4ao1dor13d****

    O ID da instância de sincronização de dados. Chame a operação DescribeSynchronizationJobs para consultar os IDs das instâncias.

    SynchronizationObjects String Sim [{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]

    Os objetos a serem sincronizados. O valor é uma string JSON que aceita expressões regulares. Consulte SynchronizationObjects.

    RegionId String Não cn-hangzhou

    O ID da região da instância de sincronização de dados. Consulte a Lista de regiões suportadas.

    SynchronizationJobName String Não MySQL Synchronization

    O nome da tarefa de sincronização de dados.

    Nota Utilize um nome descritivo para facilitar a identificação. Não é necessário que o nome seja único.
    SynchronizationDirection String Não Forward

    A direção da sincronização. Valores válidos:

    • Forward
    • Reverse
    Nota
    • Valor padrão: Forward.
    • O valor Reverse só tem efeito se a topologia da instância de sincronização de dados for sincronização bidirecional.
    SourceEndpoint.InstanceId String Não rm-bp1i99e8l7913****

    O ID da instância de origem.

    SourceEndpoint.InstanceType String Não RDS

    O tipo da instância de origem. Valores válidos:

    • RDS: Instância do ApsaraDB RDS
    • Redis: Instância do ApsaraDB for Redis
    • PolarDB: Cluster do PolarDB for MySQL ou cluster do PolarDB O Edition
    • ECS: Banco de dados autogerenciado hospedado no Elastic Compute Service (ECS)
    • Express: Banco de dados autogerenciado conectado via Express Connect
    • dg: Banco de dados autogerenciado conectado via Database Gateway
    • cen: Banco de dados autogerenciado conectado via Cloud Enterprise Network (CEN)
    Nota O valor padrão é RDS.
    SourceEndpoint.IP String Não 172.16.88.***

    O endereço IP do banco de dados de origem.

    Nota Especifique este parâmetro apenas se o parâmetro SourceEndpoint.InstanceType estiver definido como ECS, Express, dg ou cen.
    SourceEndpoint.Port String Não 3306

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

    Nota Especifique este parâmetro apenas se o parâmetro SourceEndpoint.InstanceType estiver definido como ECS, Express, dg ou cen.
    SourceEndpoint.UserName String Não dtstestaccount

    A conta do banco de dados de origem.

    Nota
    • Especifique este parâmetro apenas se o parâmetro SourceEndpoint.InstanceType estiver definido como ECS, Express, dg ou cen.
    • Se o parâmetro SourceEndpoint.InstanceType estiver definido como Redis, não é necessário especificar a conta do banco de dados.
    • As permissões necessárias variam conforme o cenário de sincronização. Consulte a Visão geral dos cenários de sincronização de dados.
    SourceEndpoint.Password String Não Test123456

    A senha da conta do banco de dados de origem.

    Nota Especifique este parâmetro apenas se o parâmetro SourceEndpoint.InstanceType estiver definido como ECS, Express, dg ou cen.
    DestinationEndpoint.InstanceId String Não rm-bp1r46452ai50****

    O ID da instância de destino.

    Nota Se o parâmetro DestinationEndpoint.InstanceType estiver definido como MaxCompute ou DataHub, especifique o nome do projeto MaxCompute ou do projeto DataHub.

    Se a instância de destino for um cluster do AnalyticDB for MySQL, especifique o ID desse cluster.

    DestinationEndpoint.InstanceType String Não RDS

    O tipo da instância de destino. Valores válidos:

    • Redis: Instância do ApsaraDB for Redis
    • RDS: Instância do ApsaraDB RDS
    • PolarDB: Cluster do PolarDB for MySQL ou cluster do PolarDB O Edition
    • ECS: Banco de dados autogerenciado hospedado no ECS
    • Express: Banco de dados autogerenciado conectado via Express Connect
    • DataHub: Projeto DataHub
    • MaxCompute: Projeto MaxCompute
    • AnalyticDB: Cluster do AnalyticDB for MySQL V3.0 ou V2.0
    • Greenplum: Instância do AnalyticDB for PostgreSQL
    Nota O valor padrão é RDS.
    DestinationEndpoint.IP String Não 172.16.88.***

    O endereço IP do banco de dados de destino.

    Nota Especifique este parâmetro apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como Express, dg ou cen.
    DestinationEndpoint.Port String Não 3306

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

    Nota Especifique este parâmetro apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como ECS, Express, dg ou cen.
    DestinationEndpoint.UserName String Não dtstestaccount

    A conta do banco de dados de destino.

    Nota
    • As permissões necessárias variam conforme o cenário de sincronização. Consulte a Visão geral dos cenários de sincronização de dados.
    • Se o parâmetro DestinationEndpoint.InstanceType estiver definido como ECS, Express, dg ou cen, especifique o parâmetro DestinationEndpoint.UserName.
    • Se o parâmetro DestinationEndpoint.InstanceType estiver definido como RDS e a versão do banco de dados for MySQL 5.5 ou MySQL 5.6, não é necessário especificar os parâmetros DestinationEndpoint.UserName e DestinationEndpoint.Password.
    • Se o parâmetro DestinationEndpoint.InstanceType estiver definido como Redis, não é necessário especificar o parâmetro DestinationEndpoint.UserName.
    DestinationEndpoint.Password String Não Test654321

    A senha da conta do banco de dados de destino.

    Nota
    • Se o parâmetro DestinationEndpoint.InstanceType estiver definido como ECS, Express, dg ou cen, especifique o parâmetro DestinationEndpoint.Password.
    SourceEndpoint.OwnerID String Não 140692647406****

    O ID da conta Alibaba Cloud proprietária da instância RDS de origem.

    Nota Obrigatório para sincronização entre contas. Especifique também o parâmetro SourceEndpoint.Role.
    SourceEndpoint.Role String Não ram-for-dts

    O nome da função RAM configurada para a conta Alibaba Cloud proprietária da instância de origem.

    Nota Obrigatório para sincronização entre contas. Consulte Configurar autorização RAM para migração e sincronização de dados entre contas.
    PartitionKey.ModifyTime_Year Boolean Não true

    Indica se a tabela de dados incrementais contém partições definidas pelo campo modifytime_year. Valores válidos: true e false.

    Nota Este parâmetro está disponível apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como MaxCompute.
    PartitionKey.ModifyTime_Month Boolean Não true

    Indica se a tabela de dados incrementais contém partições definidas pelo campo modifytime_month. Valores válidos: true e false.

    Nota Este parâmetro está disponível apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como MaxCompute.
    PartitionKey.ModifyTime_Day Boolean Não true

    Indica se a tabela de dados incrementais contém partições definidas pelo campo modifytime_day. Valores válidos: true e false.

    Nota Este parâmetro está disponível apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como MaxCompute.
    PartitionKey.ModifyTime_Hour Boolean Não true

    Indica se a tabela de dados incrementais contém partições definidas pelo campo modifytime_hour. Valores válidos: true e false.

    Nota Este parâmetro está disponível apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como MaxCompute.
    PartitionKey.ModifyTime_Minute Boolean Não true

    Indica se a tabela de dados incrementais contém partições definidas pelo campo modifytime_minute. Valores válidos: true e false.

    Nota Este parâmetro está disponível apenas se o parâmetro DestinationEndpoint.InstanceType estiver definido como MaxCompute.
    MigrationReserved String Não { "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }

    Parâmetro reservado do DTS. Uma string JSON para requisitos especiais, como a definição de início automático da pré-verificação. Consulte MigrationReserved.

    Nota Também utilizado para sincronização de dados entre instâncias do ApsaraDB for Redis Enterprise Edition. Consulte Usar o OpenAPI Explorer para configurar sincronização de dados unidirecional ou bidirecional entre instâncias do ApsaraDB for Redis Enterprise Edition.
    Checkpoint String Não 1610540493

    O ponto de verificação da sincronização.

    AccountId String Não 12323344****

    O ID da conta Alibaba Cloud. Obsoleto; será removido em uma versão futura.

    SourceEndpoint.DatabaseName String Não dtstestdata

    O nome do banco de dados ao qual pertence o objeto de sincronização na instância de origem.

    DestinationEndpoint.DataBaseName String Não dtstestdata

    O nome do banco de dados ao qual pertence o objeto de sincronização na instância de destino.

    Parâmetros de resposta

    Parâmetro

    Tipo

    Exemplo

    Descrição

    ErrCode

    String

    InternalError

    O código de erro retornado se a solicitação falhar.

    ErrMessage

    String

    The request processing has failed due to some unknown error.

    A mensagem de erro retornada se a solicitação falhar.

    RequestId

    String

    2690E467-7773-43BC-A009-370EE2E7****

    O ID da solicitação.

    Success

    String

    true

    Indica se a solicitação foi bem-sucedida.

    Exemplos

    Exemplos de solicitações

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

    Exemplos de respostas de sucesso

    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 erro

    Para obter uma lista de códigos de erro, visite a Central de Erros da API.