Todos os produtos
Search
Central de documentação

Resource Orchestration Service:ALIYUN::DTS::SynchronizationJob

Última atualização: Jun 27, 2026

O recurso ALIYUN::DTS::SynchronizationJob adquire uma instância de sincronização de dados e configure uma tarefa de sincronização.

Nota

Use ALIYUN::DTS::Instance para adquirir uma instância DTS e ALIYUN::DTS::SynchronizationJob2 para configurar a tarefa de sincronização de dados.

Sintaxe

{
  "Type": "ALIYUN::DTS::SynchronizationJob",
  "Properties": {
    "SynchronizationJobClass": String,
    "SourceEndpoint": Map,
    "PayType": String,
    "DataInitialization": Boolean,
    "Period": String,
    "DestRegion": String,
    "SourceRegion": String,
    "UsedTime": Integer,
    "SynchronizationObjects": List,
    "NetworkType": String,
    "DestinationEndpoint": Map,
    "StructureInitialization": Boolean,
    "Topology": String
  }
}

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

SynchronizationJobClass

String

Sim

Não

Especificação da instância.

Valores válidos:

  • micro

  • small (padrão)

  • medium

  • large

SourceEndpoint

Map

Sim

Não

Configurações da instância de source.

Propriedades de SourceEndpoint.

PayType

String

Não

Não

Método de faturamento.

Valores válidos:

  • Postpaid

  • Prepaid

DataInitialization

Boolean

Não

Não

Indica se a sincronização inicial completa dos dados deve ser executada.

Valores válidos:

  • true (padrão)

  • false

Period

String

Não

Não

Unidade de tempo da duração da assinatura.

Valores válidos:

  • Year

  • Month

Esta propriedade tem efeito quando PayType é definido como Prepaid.

DestRegion

String

Sim

Não

ID da região da instância de destino.

Nenhuma.

SourceRegion

String

Sim

Não

ID da região da instância de source.

Nenhuma.

UsedTime

Integer

Não

Não

Duração da assinatura.

Esta propriedade tem efeito quando PayType é definido como Prepaid.

SynchronizationObjects

List

Não

Não

Objetos a serem sincronizados.

Propriedades de SynchronizationObjects.

NetworkType

String

Não

Não

Tipo de rede para sincronização entre regiões.

Valores válidos:

  • Internet (padrão)

  • Intranet

DestinationEndpoint

Map

Sim

Não

Configurações da instância de destino.

Propriedades de DestinationEndpoint.

StructureInitialization

Boolean

Não

Não

Indica se a sincronização inicial do esquema deve ser executada.

Valores válidos:

  • true (padrão)

  • false

Topology

String

Não

Não

Topologia de sincronização.

Valores válidos:

  • oneway (padrão)

  • bidirectional

Defina como bidirectional apenas para sincronização de MySQL para MySQL.

Sintaxe de SourceEndpoint

"SourceEndpoint": {
  "UserName": String,
  "InstanceId": String,
  "IP": String,
  "Port": String,
  "Role": String,
  "OwnerID": String,
  "Password": String,
  "InstanceType": String,
  "InstanceTypeForCreation": String
}

Propriedades de SourceEndpoint

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

UserName

String

Não

Não

Nome de usuário da instância de source.

Obrigatório quando a instância de source é uma instância ECS ou um banco de dados local conectado via Express Connect. Não necessário para instâncias ApsaraDB for Redis.

InstanceId

String

Não

Não

ID da instância de source.

Nenhuma.

IP

String

Não

Não

Endereço IP da instância de source.

Obrigatório quando a instância de source é um banco de dados local conectado via Express Connect.

Port

String

Não

Não

Porta de escuta da instância de source.

Obrigatório quando a instância de source é uma instância ECS ou um banco de dados local conectado via Express Connect.

Role

String

Não

Não

Função RAM autorizada pela conta Alibaba Cloud proprietária da instância de source. Necessária quando as instâncias de source e destino pertencem a contas Alibaba Cloud diferentes. Para obter detalhes sobre permissões e autorização, consulte Configurar autorização RAM para tarefas DTS entre contas.

Nenhuma.

OwnerID

String

Não

Não

ID da conta Alibaba Cloud proprietária da instância de source. Obrigatório quando as instâncias de source e destino pertencem a contas Alibaba Cloud diferentes.

Nenhuma.

Password

String

Não

Não

Senha da instância de source.

Obrigatório quando a instância de source é uma instância ECS ou um banco de dados local conectado via Express Connect.

InstanceType

String

Sim

Não

Tipo da instância de source.

Valores válidos:

  • Redis: instância ApsaraDB for Redis

  • RDS: instância ApsaraDB RDS

  • POLARDB: cluster PolarDB for MySQL

  • ECS: banco de dados autogerenciado hospedado em uma instância ECS

  • Express: banco de dados autogerenciado conectado via circuito Express Connect

  • dg: banco de dados autogerenciado conectado via Database Gateway (DG)

  • cen: banco de dados autogerenciado conectado via Cloud Enterprise Network (CEN)

InstanceTypeForCreation

String

Não

Não

Tipo da instância de source para o canal de sincronização.

Valores válidos:

  • MySQL

  • PolarDB

  • Redis

  • SQLServer

  • PostgreSQL

  • PolarDB-X (anteriormente conhecido como DRDS)

Sintaxe de SynchronizationObjects

"SynchronizationObjects": [
  {
    "TableExcludes": List,
    "NewSchemaName": String,
    "NewDBName": String,
    "TableIncludes": List,
    "SchemaName": String,
    "DBName": String
  }
]

Propriedades de SynchronizationObjects

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

TableExcludes

List

Não

Não

Tabelas a serem excluídas da sincronização.

Nenhuma.

NewSchemaName

String

Não

Não

Nome do esquema mapeado na instância de destino.

Nenhuma.

NewDBName

String

Não

Não

Nome do banco de dados mapeado na instância de destino.

Nenhuma.

TableIncludes

List

Não

Não

Tabelas a serem sincronizadas do banco de dados de source.

Nenhuma.

SchemaName

String

Não

Não

Nome do esquema a ser sincronizado.

Nenhuma.

DBName

String

Não

Não

Nome do banco de dados a ser sincronizado.

Nenhuma.

Sintaxe de TableExcludes

"TableExcludes": [
  {
    "TableName": String
  }
]

Propriedade de TableExcludes

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

TableName

String

Não

Não

Nome da tabela.

Nenhuma.

Sintaxe de TableIncludes

"TableIncludes": [
  {
    "TableName": String,
    "FilterCondition": String,
    "ColumnExcludes": List,
    "ColumnIncludes": List,
    "NewTableName": String
  }
]

Propriedades de TableIncludes

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

TableName

String

Não

Não

Nome da tabela a ser sincronizada.

Nenhuma.

FilterCondition

String

Não

Não

Condição de filtro.

Nenhuma.

ColumnExcludes

List

Não

Não

Colunas a serem excluídas da sincronização.

Nenhuma.

ColumnIncludes

List

Não

Não

Colunas a serem sincronizadas.

Nenhuma.

NewTableName

String

Não

Não

Nome da tabela mapeada na instância de destino.

Nenhuma.

Sintaxe de ColumnExcludes

"ColumnExcludes": [
  {
    "ColumnName": String
  }
]

Propriedade de ColumnExcludes

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

ColumnName

String

Não

Não

Nome da coluna a ser excluída da sincronização.

Nenhuma.

Sintaxe de ColumnIncludes

"ColumnIncludes": [
  {
    "NewColumnName": String,
    "ColumnName": String
  }
]

Propriedades de ColumnIncludes

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

NewColumnName

String

Não

Não

Nome da coluna mapeada na instância de destino.

Nenhuma.

ColumnName

String

Não

Não

Nome da coluna a ser sincronizada.

Nenhuma.

Sintaxe de DestinationEndpoint

"DestinationEndpoint": {
  "UserName": String,
  "InstanceId": String,
  "IP": String,
  "InstanceType": String,
  "Password": String,
  "InstanceTypeForCreation": String,
  "Port": String
}

Propriedades de DestinationEndpoint

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

UserName

String

Não

Não

Nome de usuário da instância de destino.

Obrigatório quando a instância de destino é uma instância ECS ou um banco de dados local conectado via Express Connect. Não necessário para instâncias ApsaraDB for Redis.

InstanceId

String

Não

Não

ID da instância de destino.

  • Para destinos MaxCompute, defina como o nome do projeto MaxCompute.

  • Para destinos AnalyticDB for MySQL, defina como o ID do cluster.

  • Para destinos DataHub, defina como o nome do projeto DataHub.

IP

String

Não

Não

Endereço IP da instância de destino.

Obrigatório quando a instância de destino é um banco de dados local conectado via Express Connect.

InstanceType

String

Sim

Não

Tipo da instância de destino.

Valores válidos:

  • Redis: instância ApsaraDB for Redis

  • RDS (padrão): instância ApsaraDB RDS

  • POLARDB: cluster PolarDB for MySQL

  • ECS: banco de dados autogerenciado hospedado em uma instância ECS

  • Express: banco de dados autogerenciado conectado via circuito Express Connect

  • MaxCompute: projeto MaxCompute

  • DataHub: projeto DataHub

  • AnalyticDB: cluster AnalyticDB for MySQL V2.0

  • AnalyticDB30: cluster AnalyticDB for MySQL V3.0

InstanceTypeForCreation

String

Não

Não

Tipo da instância de destino para o canal de sincronização.

Valores válidos:

  • MySQL

  • PolarDB

  • Redis

  • MaxCompute

  • DataHub

  • Kafka

  • Elasticsearch

  • Tablestore

Password

String

Não

Não

Senha da instância de destino.

Obrigatório quando a instância de destino é uma instância ECS ou um banco de dados local conectado via Express Connect.

Port

String

Não

Não

Porta de escuta da instância de destino.

Obrigatório quando a instância de destino é uma instância ECS ou um banco de dados local conectado via Express Connect.

Valores de retorno

Fn::GetAtt

SynchronizationJobId: ID da instância de sincronização de dados.

Exemplos

  • YAML formato

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RdsId:
        Type: String
        AssociationProperty: ALIYUN::RDS::Instance::InstanceId
    Resources:
      SynchronizationJob:
        Type: ALIYUN::DTS::SynchronizationJob
        Properties:
          SynchronizationJobClass: small
          SourceEndpoint:
            InstanceId:
              Ref: RdsId
            InstanceTypeForCreation: MySQL
            InstanceType: RDS
          PayType: Postpaid
          DataInitialization: false
          DestRegion:
            Ref: ALIYUN::Region
          SourceRegion:
            Ref: ALIYUN::Region
          NetworkType: Internet
          DestinationEndpoint:
            InstanceId:
              Ref: RdsId
            InstanceTypeForCreation: MySQL
            InstanceType: RDS
          StructureInitialization: false
    Outputs:
      SynchronizationJobId:
        Description: Synchronization instance ID
        Value:
          Fn::GetAtt:
            - SynchronizationJob
            - SynchronizationJobId
  • JSON formato

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RdsId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId"
        }
      },
      "Resources": {
        "SynchronizationJob": {
          "Type": "ALIYUN::DTS::SynchronizationJob",
          "Properties": {
            "SynchronizationJobClass": "small",
            "SourceEndpoint": {
              "InstanceId": {
                "Ref": "RdsId"
              },
              "InstanceTypeForCreation": "MySQL",
              "InstanceType": "RDS"
            },
            "PayType": "Postpaid",
            "DataInitialization": false,
            "DestRegion": {
              "Ref": "ALIYUN::Region"
            },
            "SourceRegion": {
              "Ref": "ALIYUN::Region"
            },
            "NetworkType": "Internet",
            "DestinationEndpoint": {
              "InstanceId": {
                "Ref": "RdsId"
              },
              "InstanceTypeForCreation": "MySQL",
              "InstanceType": "RDS"
            },
            "StructureInitialization": false
          }
        }
      },
      "Outputs": {
        "SynchronizationJobId": {
          "Description": "Synchronization instance ID",
          "Value": {
            "Fn::GetAtt": [
              "SynchronizationJob",
              "SynchronizationJobId"
            ]
          }
        }
      }
    }