All Products
Search
Document Center

Cloud Migration Hub:Parameters for batch assistant

Last Updated:Aug 12, 2024

This topic describes the parameters that are used for the batch assistant feature of Cloud Migration Hub (CMH) and provides related references.

Parameters for adding migration configurations

Parameter

Description

Remarks

Task name

The name of the task to which the migration configurations apply.

Instance type

The type of the source or destination instance.

Valid values if you want to migrate data from or to an Alibaba Cloud database:

  • RDS: ApsaraDB RDS for MySQL, ApsaraDB RDS for SQL Server, ApsaraDB RDS for PostgreSQL, or ApsaraDB RDS for MariaDB TX instance

  • PolarDB: PolarDB for MySQL cluster

Valid values if you want to migrate data from or to a self-managed database:

  • OTHER: self-managed database that can be accessed from a public IP address

  • EXPRESS: self-managed database that is connected over Express Connect

  • DG: self-managed database that is connected over Database Gateway

Note

  • If you want to migrate data from a self-managed database, you must make relevant preparations. For more information, see Preparation overview.

Instance area

The region in which the source or destination instance resides.

  • Specify the ID of the region. For more information, see the "Appendix: Region IDs" section of this topic.

Instance ID

The instance ID.

  • The instance ID must be unique within a task.

  • If the instance with the specified ID has been used in a migration plan, make sure that the instance is not in the Migrating state.

  • If you want to migrate data from or to an Alibaba Cloud database, set this parameter to the ID of the database. For example, if you select RDS from the Instance type drop-down list and select MYSQL from the Database type drop-down list, you must specify the ID of the ApsaraDB RDS for MySQL instance.

  • If you select OTHER from the Instance type drop-down list, set the instance ID to a random string.

  • If you select EXPRESS from the Instance type drop-down list, set the instance ID to the ID of the virtual private cloud (VPC) that is connected to the source database.

  • If you select DG from the Instance type drop-down list, set the instance ID to the ID of the database gateway.

Database type

The database engine of the source or destination instance.

  • MYSQL: ApsaraDB RDS for MySQL instance or self-managed MySQL database

  • POLARDB_O: PolarDB for Oracle cluster

  • ORACLE: self-managed Oracle database

Database name

The name of the source or destination database.

  • This parameter is required only if you select POLARDB_O from the Database type drop-down list.

IP address

The IP address of the source or destination database.

  • This parameter is required only if you select OTHER, EXPRESS, or DG from the Instance type drop-down list.

Port

The port that is used to connect to the source or destination database.

  • This parameter is required only if you configure the IP address parameter.

Database account

The database account used for the migration.

  • Make sure that the account has the read and write permissions on the database and tables to be migrated.

Database password

The password of the database account used for the migration.

Table mapping definition

The database and table mappings for the migration.

  • CMH provides an example of table mapping definitions for database migration.

  • For more information, see Objects of DTS tasks.

Parameters for creating a batch assistant task

Parameter

Description

Remarks

Batch assistant name

The name of the batch assistant task.

Database type

The database engine of the source instance.

  • The system automatically configures this parameter for you.

  • This parameter is used for identification only and does not affect the configurations that you specify in the first step.

Migration type

The migration method.

  • Full migration: schema migration and full data migration.

  • Full + Incremental Migration: schema migration, full migration, and incremental migration.

  • Incremental migration does not automatically stop. You must manually stop the task in the Data Transmission Service (DTS) console.

Instance size

The specifications of the DTS instance that you purchase.

Migration plan name

The migration plan to which you want to add the migration task.

  • After the migration task is submitted, the system automatically adds the task to the specified migration plan. You can view your migration task in the migration plan.

  • If the task already exists in a migration plan, the system automatically moves the task from the original migration plan to the new migration plan that you specify.

Whether to start the migration task automatically

Specifies whether to automatically start the migration task.

  • Yes: The precheck and database migration are automatically started after the task is submitted.

  • No: The precheck is automatically started after the task is submitted. However, you need to manually start the migration task in the DTS console.

Whether to join packet scheduling

Specifies whether to add the migration task to a scheduling group.

  • Yes: adds the migration task to a scheduling group that is in the Open state. CMH automatically schedules the migration task based on the specified scheduling rule.

  • No: does not add the migration task to a scheduling group. After the migration task is submitted, the migration task immediately starts to run.

Appendix: Region IDs

Region

Region ID

China (Hangzhou)

cn-hangzhou

China (Shanghai)

cn-shanghai

China (Qingdao)

cn-qingdao

China (Beijing)

cn-beijing

China (Zhangjiakou)

cn-zhangjiakou

China (Hohhot)

cn-huhehaote

China (Shenzhen)

cn-shenzhen

China (Heyuan)

cn-heyuan

China (Guangzhou)

cn-guangzhou

China (Chengdu)

cn-chengdu

China (Hong Kong)

cn-hongkong

Singapore

ap-southeast-1

Malaysia (Kuala Lumpur)

ap-southeast-3

Indonesia (Jakarta)

ap-southeast-5

Philippines (Manila)

ap-southeast-6

Thailand (Bangkok)

ap-southeast-7

Japan (Tokyo)

ap-northeast-1

South Korea (Seoul)

ap-northeast-2

US (Silicon Valley)

us-west-1

US (Virginia)

us-east-1

Germany (Frankfurt)

eu-central-1

UK (London)

eu-west-1

SAU (Riyadh - Partner Region)

me-central-1

UAE (Dubai)

me-east-1

China East 1 Finance

cn-hangzhou-finance

China East 2 Finance

cn-shanghai-finance-1

China South 1 Finance

cn-shenzhen-finance-1

China North 2 Finance (Preview)

cn-beijing-finance-1

China North 2 Ali Gov 1

cn-north-2-gov-1