Adding a Cloud Database

Prerequisites

• You have logged in to DMS.

• You have joined the team.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. Click the Add Instance button, and the right drawer appears for editing.

3. Select Cloud Database as the data source and enter the information about the instance. The related parameters are described below.

Parameter Description of Adding a Cloud Database

Parameter Item	Description
Team	The team to which the instance belongs after it is added successfully.
Instance Name	The name of the instance displayed in DMS.
Environment	The environment identification, such as development, test, pre-release, production, and more.
Instance Property	The read and write properties of the instance, such as read-write and read-only.
Data Source	The source of the instances, such as cloud database and public network/directly connected database.
Database Type	The data type, such as MySQL, PostgreSQL, SQLServer, DRDS, and DDS.
Region/Resource Pool	The resource pool to which the cloud database belongs.
Cloud Database	Basic information about the cloud database, including IP and port.
Maximum Number of Connections	The maximum number of connections the current user can obtain.
Database Account	The database account used to log in to the instance.
Database Password	The password used to log in to your account.

4. After completing the above information, click the Test Connection button.

5. After the Successful Connection prompt appears, click the OK button to finish adding the cloud database.

² Description

• The Test Connection function is only available when a database account and database password have been entered.

• Enter the correct database account and database password and click the OK button to automatically log in and synchronize the metadata. Otherwise, only the instance information is entered. If the instance is not logged in, the metadata will not be automatically synchronized.

• After entering an instance, ordinary users automatically act as the instance owner. The instance owner has permission to edit and delete the instance by default.

• Instances with SSL enabled may fail to add.

• The Team drop-down list has a Create Team option for fast creation of teams and completing backfilling.

Adding a Public Network/Directly Connected Database

Prerequisites

• You have logged in to DMS.

• You have joined the team.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. Click the Add Instance button, and the right drawer appears for editing.

3. Select Public Network/Direct Connection Database as the data source and enter the information about the instance. The related parameters are described below.

Parameter Description for Adding a Public Network/Directly Connected Database

Parameter Item	Description
Team	The team to which the instance belongs after it is added successfully.
Instance Name	The name of the instance displayed in DMS.
Environment	The environment identification, such as development, test, pre-release, production, and more.
Instance Property	The read and write properties of the instance, such as read-write and read-only.
Data Source	The source of the instances, such as cloud database and public network/directly connected database.
Database Type	The data type, such as MySQL, PostgreSQL, SQLServer, DRDS, MongoDB, and DDS.
Connection Address	The IP and port of the public network/directly connected database.
Maximum Number of Connections	The maximum number of connections the current user can obtain.
Database Account	The database account used to log in to the instance.
Database Password	The password used to log in to your account.

4. After completing the above information, click the Test Connection button.

5. After the Successful Connection prompt appears, click the OK button to finish adding the cloud database.

² Description

• The Test Connection function is only available when a database account and database password have been entered.

• After entering an instance, ordinary users automatically act as the instance owner. The instance owner has permission to edit and delete the instance by default.

• Instances with SSL enabled may fail to add.

• The Team drop-down list has a Create Team option for fast creation of teams and completing backfilling.

Synchronizing Cloud Database

Prerequisites

• You have logged in to DMS.

• The login user has viewing or higher permissions to the instance.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. On the Instance List page, click the Synchronize Cloud Database button.

3. Click the OK button to start synchronizing the cloud database instance enabled by the current user.

4. After synchronization is complete, you can see the corresponding instance information in DMS.

Synchronizing Metadata

Prerequisites

• You have logged in to DMS.

• The login user has viewing or higher permissions to the instance.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. Locate the target instance in the list and find More > Synchronize Metadata in the Operate bar.

3. Click the OK button to start the metadata synchronization for the current instance.

4. Synchronization is complete when the Successful Synchronization prompt appears on the page.

² Note

It is normal to experience a short period of lagging because synchronizing metadata consumes a certain amount of computing resources.

RDS Console

Prerequisites

You have logged in to DMS.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. On the Instance List page, click the RDS Console button.

3. Select the corresponding database type and the target resource pool.

4. Click the OK button to navigate to the Instance Management Console page for the corresponding resource pool.

Enabling Database Audit

Prerequisites

• You have entered a MySQL or DDS cloud database instance.

• The MySQL database resource pool supports Southwest 1, East China 1, Shanghai 36, North China 2, Changsha 42, and South China 2.

• The DDS database resource pool supports Shanghai 36.

• For MySQL databases, you need to enable the SQL Audit Log function in the RDS Console. For details, see Log Management.

Precautions

The default save duration for audit logs is 7 days. The setting range is 1 to 180 days.

Enabling/Disabling Database Audit

The platform provides multiple ways to enable/disable database audit:

• In the left navigation bar, click Data Source Management > Instance Metadata, find the target instance, and click Enable/Disable in the Database Audit column to enable or disable the function.

• In the left navigation bar, click Security Center > Audit Log and click the Database Audit Log tab. Then, click the Enable Audit Log button on the page to select the target instance and enable the log audit.

Favoring Instances

Prerequisites

• You have logged in to DMS.

• The login user has viewing or higher permissions to the instance.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. Locate the target instance in the list and click in the list to favor the instance or cancel favoring.

Logging in to the Database

Prerequisites

• You have logged in to DMS.

• The database account used for login has sufficient access permission to the database tables.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. Locate the target instance in the instance list and click the Login button, and the login pop-up window appears.

3. Enter the database account and database password in the login pop-up window.

4. Click the OK button to finish login.

5. After successful login, the Login button in the original list changes to Switch Accounts.

² Description

Instances with SSL enabled may fail to log in.

Database Management

Prerequisites

• You have logged in to DMS.

• The database account used for login has sufficient access permission to the database tables.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List page.

2. Locate the target instance in the instance list and click the Database List button to go to the Database List page.

3. For detailed database management, see Database List.

² Description

To synchronize database metadata in real time, click the Synchronize Metadata button to synchronize manually.

Navigating to the Query Window

Prerequisites

• You have logged in to DMS.

• The login user has viewing or higher permissions to the instance.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. Locate the target instance in the list and find the Query button in the Operate bar.

3. When you click the Query button, you will be navigated to the Query Window page of DMS.

4. On the Query Window page, you can directly enter SQL scripts to access the target database.

Instance Details

Prerequisites

• You have logged in to DMS.

• The login user has viewing or higher permissions to the instance.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. Locate the target instance in the list and find More > Details button in the Operate bar.

3. Click the Details button, and the Instance Details pop-up window displays the information of all instances.

Editing Instances

Prerequisites

• You have logged in to DMS.

• The login user role is super administrator, team administrator, or instance owner.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. Locate the target instance in the list and click More > Edit Instance.

3. The Edit pop-up window mainly contains the basic information of the instance. Main editable information includes team, instance name, environment, maximum number of connections, and more.

4. After editing the instance information, click the OK button to finish modifying the instance information.

² Description

• The Team drop-down list has a Create Team option for fast creation of teams and completing backfill.

Disabling or Enabling an Instance

Prerequisites

• You have logged in to DMS.

• The login user role is super administrator, team administrator, or instance owner.

Precautions

• Disable Instance: This operation is available for enabled instances. When an instance is disabled, login, query, and other operations are not available. Please operate with caution.

• Enable Instance: This operation is available for disabled instances. When an instance is enabled, login, query, and other operations are resumed.

Procedure

1. Log in to DMS.

2. On the left menu bar, click Data Source Management > Instance Metadata to go to the Instance List interface.

3. Locate the target instance in the list and find More > Disable Instance/Enable Instance in the Operate bar.

4. Click the OK button to finish disabling/enabling the instance.

Deleting an Instance

Prerequisites

• You have logged in to DMS.

• The login user role is super administrator, team administrator, or instance owner.

Procedure

1. Click Data Source Management > Instance Metadata to go to the Instance List interface.

2. Locate the target instance in the list and click More > Delete Instance.

3. Click the OK button to finish deleting the instance information in DMS.

² Description

This operation only deletes the instance metadata entered in DMS and does not affect the instance status in the real running environment.

Data Management Service (DMS)