Data Management:Register a cloud database

Usage notes

• To manage an instance with DMS, we recommend creating a dedicated database account instead of reusing an existing one. The permission requirements for the database account are as follows:

  • To manage all databases in the instance, grant the account permissions on the entire instance.

  • To manage one or more specific databases, grant the account permissions for those databases only.

  • To perform Data Manipulation Language (DML) operations such as creating, deleting, updating, and querying data, or modifying table structures, the account needs sufficient DML permissions.

  • To perform operations on objects such as views, stored procedures, triggers, and functions, the account needs the required permissions for those objects.

• To avoid errors, do not add leading or trailing spaces or other special characters to the information that you enter.

• When you register a cloud database, DMS typically prompts you to configure a whitelist. If you do not see a prompt and cannot manage the database in DMS, you must manually add the DMS IP address range to the security settings of your database.

Register an instance

This example shows how to register an ApsaraDB RDS for MySQL instance.

1. Log in to DMS 5.0.

2. In the Database Instances section of the navigation pane on the left, click the Add Instance icon.

   Note

   Alternatively, choose Data Assets > Instances from the top navigation bar and click New on the Instances page.

3. On the Add Instance page, enter the instance information.

   Category	Parameter	Description
   Data Source	-	By default, Alibaba Cloud-MySQL is selected. You can select a different database type.
   Basic Information	Database Type	Select the type of your database instance. Note After you select a database type, DMS automatically refreshes the parameters in the Basic Information section.
   	Instance Region	Select the region where your database instance is located.
   	Other primary accounts	This parameter appears if you select Cross-Alibaba Cloud account instances. Select the Alibaba Cloud account to which the database instance belongs. Note If the Alibaba Cloud account is not in the list, you can click Add User to add the Alibaba Cloud account of the instance owner. For more information, see Add a user.
   	Registration method	Select how to register the instance. You can use the Instance ID or the Connection String Address.
   	Instance ID or Connection String Address	Enter the Instance ID or Connection String Address. Note A connection string address consists of an internal endpoint and a port number. For example: rm-XXXXXXX.mysql.rds.aliyuncs.com:3306.
   	Access mode	Select the logon method and whether to enable security hosting for the instance. Security hosting allows you to manage permissions at a fine-grained level without exposing database credentials. Security Hosting - Automatic (Recommended): DMS automatically enables security hosting and creates a database account for you to log on to the instance through DMS. Note This parameter is available only when you register an RDS instance. You can view the account that is automatically created by DMS in the RDS console. Do not modify or delete this account, as doing so can disrupt DMS features. Except for ApsaraDB RDS for PostgreSQL instances, accounts that are automatically created by DMS in other RDS instances do not have the permissions to create databases or database accounts. Security Hosting - Manual: DMS enables security hosting, but you must manually provide the credentials of an existing database account. Security Hosting - KMS: DMS enables security hosting, but you must select an RDS credential created in KMS to log on to the database. Note This parameter is available only when you register an RDS instance. Disable Security Hosting (Not Recommended): If security hosting is disabled, you must frequently use your database account and password to log on, which may interfere with normal functionality.
   	Advanced feature pack	Select a feature pack based on your needs. Security Collaboration or Stable Change (select one): Security Collaboration includes all capabilities of Stable Change and adds DevOps features for flexible R&D and approval workflow customization. Stable Change provides solutions for enhanced database stability, such as lock-free schema changes and SQL reviews. Note If you select neither the Security Collaboration nor Stable Change pack, the instance uses the Flexible Management mode by default. Sensitive Data Protection: This feature enables you to control and mask sensitive data. Enable this feature based on your business requirements. For more information, see Enable Sensitive Data Protection.
   	Security rule	This parameter appears if you select the Security Collaboration pack. You can select default or custom security rules for fine-grained control over the database.
   	Classification and grading template	The settings for the classification and grading template are displayed only when Sensitive Data Protection is enabled. By binding a classification and grading template to the instance, you can identify fields in database tables that match the template's rules. Matching fields are automatically tagged with classification and sensitivity levels to protect highly sensitive fields.
   Advanced Information	Environment Type	Select the type of the database environment.
   	Instance Name	Clear the Automatically Synchronize Instance Name checkbox to set a custom display name for the instance in DMS. Note When you register a cloud database for the first time, DMS synchronizes the name from the source instance. This synchronization does not occur for subsequent registrations. You can update the instance name by editing the instance.
   	Lock-free Schema Change	Select whether to enable the lock-free schema change feature. Note This parameter appears only for MySQL databases.
   	Enable SSL	Note This parameter appears only for MySQL or Redis databases. By default, SSL connections are disabled in DMS. If you need to connect to the database using SSL, you can manually enable it here. Ensure that SSL is also enabled on your database. Secure Sockets Layer (SSL) encrypts data at the transport layer to enhance security and integrity, but it may increase connection latency.
   	Instance DBA	Select a DBA to handle subsequent processes such as permission requests.
   	Query Timeout (s)	Set a security policy to terminate a query in the SQL console if it exceeds the specified time limit. This protects the database from long-running queries.
   	Export Timeout (s)	Set a security policy to terminate an export task in the SQL console if it exceeds the specified time limit. This protects the database from long-running exports.

4. After entering the required information, click Test Connection in the lower-left corner.

   Note

   If the connection test fails, review the instance information you entered and correct any errors based on the error message.

5. After the Connection successful message appears, click Submit.

   The cloud database is now registered with DMS. You can view and manage it from the instance list on the left side of the DMS console.

Related operations

• If you change the access mode from Security Hosting - Automatic to another mode and then change it back, DMS resets the password of the account that was first automatically generated.

• To access resources in another Alibaba Cloud account's DMS or register your resources in another account's DMS, you must perform the cross-account access or registration operations.

• After registering a database with DMS, you can perform the following operations:

  • Perform basic database operations such as creating databases and tables, querying data, and changing data. For more information, see Get started with SQL Console.

  • Use the lock-free data change feature in DMS to change a large amount of data in a table without locking it.

  • Export table data.

• Register an instance using the AddInstance API.

FAQ

• Q: When I register an Alibaba Cloud database in DMS, I see a prompt about a whitelist issue. What should I do?

  The pop-up window indicates that the IP address range 100.104.175.0/24 needs to be added and prompts you to click Configure Whitelist to add this range to the current instance whitelist by overwriting existing entries.

  A: Click Configure Whitelist in the prompt. The system attempts to automatically add the DMS server's IP address range to your cloud database's whitelist. If this fails, you must add it manually. For more information, see Add the DMS IP address range.

• Q: Is the Flexible Management mode no longer available in DMS?

  A: It is still available. If you do not select the Stable Change or Security Collaboration pack when you register an instance, the instance uses the Flexible Management mode by default.

• Q: After I enable TLS/SSL encryption for a Redis instance, I am unable to log on to the database from DMS and receive an error message that an SSL connection is required. How can I resolve this issue?

  Error message: ERR must use ssl connection in ssl port.

  A: You can resolve this issue by editing the instance:

  1. Log in to DMS 5.0.

  2. In the navigation pane on the left, choose Database Instances > Instances Disconnected. Find and right-click the target Redis instance, and then click Edit Instance.

  3. In the Advanced Information section, Enable SSL.

  4. After enabling SSL, click Test Connection.

  5. After the connection test is successful, click Save. The database can now connect to DMS.

• For more information about common issues with logging on to a database, see Log on to a database.