ALIYUN::DTS::MigrationJob - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

ALIYUN::DTS::MigrationJob se usa para adquirir una instancia de migración de datos y configurar una tarea de migración de datos.

Nota

Se recomienda usar ALIYUN::DTS::Instance para adquirir una instancia de Data Transmission Service (DTS) y ALIYUN::DTS::MigrationJob2 para configurar la tarea de migración de datos.

Sintaxis

{
  "Type": "ALIYUN::DTS::MigrationJob",
  "Properties": {
    "MigrationJobClass": String,
    "SourceEndpoint": Map,
    "MigrationJobName": String,
    "MigrationMode": Map,
    "DestinationEndpoint": Map,
    "MigrationObject": List
  }
}

Propiedades

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
MigrationJobClass	String	Sí	No	Especificación de la instancia de migración de datos.	Valores válidos: small medium large Para obtener más información sobre las pruebas de rendimiento de cada especificación, consulte Specifications of data migration instances.
SourceEndpoint	Map	No	Sí	Configuración de la instancia de origen.	Ninguna.
MigrationJobName	String	No	Sí	Nombre de la tarea de migración de datos.	Ninguna.
MigrationMode	Map	No	Sí	Modo de la tarea de migración de datos.	Ninguna.
DestinationEndpoint	Map	No	Sí	Configuración de la instancia de destino.	Ninguna.
MigrationObject	List	No	Sí	Objetos que desea migrar.	Ninguna.

Sintaxis de SourceEndpoint

"SourceEndpoint": {
  "UserName": String,
  "OracleSID": String,
  "InstanceID": String,
  "IP": String,
  "Region": String,
  "InstanceType": String,
  "Role": String,
  "DatabaseName": String,
  "OwnerID": String,
  "EngineName": String,
  "Password": String,
  "Port": String
}

Propiedades de SourceEndpoint

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
UserName	String	Sí	Sí	Nombre de usuario para acceder a la instancia de origen.	Ninguna.
OracleSID	String	No	Sí	ID del sistema (SID) de la base de datos Oracle de origen si el tipo de motor de la instancia de origen es Oracle.	Ninguna.
InstanceID	String	No	Sí	ID de la instancia de origen.	Especifique esta propiedad según el valor de InstanceType.
IP	String	No	Sí	Dirección IP de la instancia de origen.	Especifique esta propiedad cuando la instancia de origen sea una base de datos autogestionada local.
Region	String	Sí	Sí	ID de región de la instancia de origen.	Ninguna.
InstanceType	String	Sí	Sí	Tipo de la instancia de origen.	Valores válidos: RDS: instancia de ApsaraDB RDS ECS: base de datos autogestionada alojada en una instancia de Elastic Compute Service (ECS) LocalInstance: base de datos autogestionada con dirección IP pública Express: base de datos autogestionada conectada mediante un circuito de Express Connect MongoDB: instancia de ApsaraDB for MongoDB POLARDB: clúster de PolarDB for MySQL
Role	String	No	Sí	Nombre del rol de Resource Access Management (RAM) autorizado por la cuenta de Alibaba Cloud a la que pertenece la instancia de origen. Esta propiedad surte efecto cuando la instancia de origen es una instancia de ApsaraDB RDS y las instancias de origen y destino pertenecen a diferentes cuentas de Alibaba Cloud.	Especifique esta propiedad cuando migre datos entre diferentes cuentas de Alibaba Cloud. Para obtener más información sobre los permisos obligatorios del rol de RAM y cómo otorgarlos, consulte Configure RAM authorization for cross-account DTS tasks.
DatabaseName	String	No	Sí	Nombre de la base de datos.	Esta propiedad especifica el nombre de la base de datos que se usa para establecer la conexión si el tipo de motor de la instancia de origen es PostgreSQL o MongoDB.
OwnerID	String	No	Sí	ID de la cuenta de Alibaba Cloud a la que pertenece la instancia de origen. Esta propiedad surte efecto cuando la instancia de origen es una instancia de ApsaraDB RDS y las instancias de origen y destino pertenecen a diferentes cuentas de Alibaba Cloud.	Ninguna.
EngineName	String	No	Sí	Tipo de motor de la instancia de origen.	Valores válidos: MySQL SQLServer PostgreSQL Oracle MongoDB Redis Especifique esta propiedad cuando InstanceType no esté configurado como RDS.
Password	String	Sí	Sí	Contraseña para acceder a la instancia de origen.	Ninguna.
Port	String	No	Sí	Puerto de escucha de la instancia de origen.	Especifique esta propiedad cuando la instancia de origen sea una base de datos autogestionada.

Sintaxis de MigrationMode

"MigrationMode": {
  "DataIntialization": Boolean,
  "StructureIntialization": Boolean,
  "DataSynchronization": Boolean
}

Propiedades de MigrationMode

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
DataIntialization	Boolean	No	Sí	Indica si se realiza la migración completa de datos en la tarea de migración.	Valores válidos: true false
StructureIntialization	Boolean	No	Sí	Indica si se realiza la migración de esquemas en la tarea de migración.	Valores válidos: true false
DataSynchronization	Boolean	No	Sí	Indica si se realiza la sincronización incremental de datos en la tarea de migración.	Valores válidos: true false

Sintaxis de DestinationEndpoint

"DestinationEndpoint": {
  "UserName": String,
  "InstanceID": String,
  "IP": String,
  "Region": String,
  "Port": String,
  "Role": String,
  "DatabaseName": String,
  "EngineName": String,
  "Password": String,
  "InstanceType": String
}

Propiedades de DestinationEndpoint

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
UserName	String	Sí	Sí	Nombre de usuario para acceder a la instancia de destino.	Ninguna.
InstanceID	String	No	Sí	ID de la instancia de destino.	Ninguna.
IP	String	No	Sí	Dirección IP de la instancia de destino.	Especifique esta propiedad cuando la instancia de destino sea una base de datos autogestionada local.
Region	String	Sí	Sí	ID de región de la instancia de destino.	Si la instancia de destino es una base de datos autogestionada, puede especificar el ID de la región geográficamente más cercana a su centro de datos autogestionado.
Port	String	No	Sí	Puerto de escucha de la instancia de destino.	Especifique esta propiedad cuando la instancia de destino sea una base de datos autogestionada.
DatabaseName	String	No	Sí	Nombre de la base de datos de la instancia de destino.	Especifique esta propiedad cuando el tipo de motor de la instancia de destino sea PostgreSQL, PPAS o MongoDB.
EngineName	String	No	Sí	Tipo de motor de la base de datos de destino.	Especifique esta propiedad únicamente cuando InstanceType esté configurado como RDS, ECS, LocalInstance o Express.
Password	String	Sí	Sí	Contraseña para acceder a la instancia de destino.	Ninguna.
InstanceType	String	Sí	Sí	Tipo de la instancia de destino.	El valor de esta propiedad debe ser igual al valor de SourceEndpoint.InstanceType.
Role	String	No	Sí	Nombre del rol de RAM autorizado por la cuenta de Alibaba Cloud a la que pertenece la instancia de destino. Esta propiedad surte efecto cuando la instancia de origen es una instancia de ApsaraDB RDS y las instancias de origen y destino pertenecen a diferentes cuentas de Alibaba Cloud.	Ninguna.

Sintaxis de MigrationObject

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

Propiedades de MigrationObject

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
TableExcludes	List	No	No	Nombres de las tablas que no desea migrar desde la base de datos de origen.	Ejemplo: `[{"TableName": "a"}, {"TableName": "b"}, ...]`.
NewSchemaName	String	No	No	Nombre asignado al esquema que desea migrar a la instancia de destino.	Esta propiedad está disponible cuando EngineName está configurado como SQLServer.
NewDBName	String	No	No	Nombre asignado a la base de datos que desea migrar a la instancia de destino.	Esta propiedad no está disponible cuando EngineName está configurado como SQLServer.
TableIncludes	List	No	No	Nombres de las tablas que desea migrar desde la base de datos de origen.	Ninguna.
SchemaName	String	No	No	Nombre del esquema que desea migrar.	Esta propiedad está disponible cuando EngineName está configurado como SQLServer.
DBName	String	No	No	Nombre de la base de datos que desea migrar.	Esta propiedad no está disponible cuando EngineName está configurado como SQLServer. Si solo especifica la propiedad DBName y deja vacías las demás propiedades de esta tabla, el sistema migra todos los objetos contenidos en la base de datos. Si especifica la propiedad DBName junto con otras propiedades de esta tabla, el sistema migra únicamente los objetos correspondientes a las propiedades especificadas de forma predeterminada.

Sintaxis de TableIncludes

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

Propiedades de TableIncludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
ColumnExcludes	List	No	No	Nombres de las columnas que no desea migrar desde la base de datos de origen.	Ejemplo: `[{"ColumnName": "a"}, {"ColumnName": "b"}, ...]shou'xia`.
FilterCondition	String	No	No	Condición de filtro.	Ninguna.
NewTableName	String	No	No	Nombre asignado a la tabla que desea migrar a la instancia de destino.	Ninguna.
TableName	String	No	No	Nombre de la tabla que desea migrar.	Ninguna.
ColumnIncludes	List	No	No	Nombres de las columnas que desea migrar desde la tabla de origen.	Ninguna.

Sintaxis de ColumnIncludes

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

Propiedades de ColumnIncludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
ColumnName	String	No	No	Nombre de la columna que desea migrar desde la tabla de origen.	Ninguna.
NewColumnName	String	No	No	Nombre asignado a la columna que desea migrar a la instancia de destino.	Ninguna.

Sintaxis de ColumnExcludes

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

Propiedad de ColumnExcludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
ColumnName	String	No	No	Nombre de la columna que no se migra desde la tabla de origen.	Ninguna.

Sintaxis de TableExcludes

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

Propiedad de TableExcludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
TableName	String	No	No	Nombre de la tabla que no desea migrar desde la base de datos de origen.	Ninguna.

Valores de retorno

Fn::GetAtt

MigrationJobId: ID de la tarea de migración de datos.

Ejemplos

Formato YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RdsInstanceId:
    Type: String
    AssociationProperty: ALIYUN::RDS::Instance::InstanceId
Resources:
  MigrationJob:
    Type: ALIYUN::DTS::MigrationJob
    Properties:
      MigrationJobClass: small
      MigrationJobName:
        Ref: ALIYUN::StackName
      MigrationMode:
        StructureIntialization: true
        DataSynchronization: true
        DataIntialization: true
      SourceEndpoint:
        UserName: admin
        InstanceID:
          Ref: RdsInstanceId
        Region:
          Ref: ALIYUN::Region
        InstanceType: RDS
        Password: Admin@123
        Port: '3306'
      DestinationEndpoint:
        EngineName: MySQL
        Port: '3306'
        Region:
          Ref: ALIYUN::Region
        InstanceID:
          Ref: RdsInstanceId
        Password: Admin@123
        UserName: admin
        InstanceType: RDS
      MigrationObject:
        - DBName: MySQLDataBase
Outputs:
  MigrationJobId:
    Description: Migration tasks task ID
    Value:
      Fn::GetAtt:
        - MigrationJob
        - MigrationJobId

Formato JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RdsInstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId"
    }
  },
  "Resources": {
    "MigrationJob": {
      "Type": "ALIYUN::DTS::MigrationJob",
      "Properties": {
        "MigrationJobClass": "small",
        "MigrationJobName": {
          "Ref": "ALIYUN::StackName"
        },
        "MigrationMode": {
          "StructureIntialization": true,
          "DataSynchronization": true,
          "DataIntialization": true
        },
        "SourceEndpoint": {
          "UserName": "admin",
          "InstanceID": {
            "Ref": "RdsInstanceId"
          },
          "Region": {
            "Ref": "ALIYUN::Region"
          },
          "InstanceType": "RDS",
          "Password": "Admin@123",
          "Port": "3306"
        },
        "DestinationEndpoint": {
          "EngineName": "MySQL",
          "Port": "3306",
          "Region": {
            "Ref": "ALIYUN::Region"
          },
          "InstanceID": {
            "Ref": "RdsInstanceId"
          },
          "Password": "Admin@123",
          "UserName": "admin",
          "InstanceType": "RDS"
        },
        "MigrationObject": [
          {
            "DBName": "MySQLDataBase"
          }
        ]
      }
    }
  },
  "Outputs": {
    "MigrationJobId": {
      "Description": "Migration tasks task ID",
      "Value": {
        "Fn::GetAtt": [
          "MigrationJob",
          "MigrationJobId"
        ]
      }
    }
  }
}