Help Center> Document Database Service> User Guide> Instance Modifications> Changing Cluster Instance Nodes> Adding Read Replicas to a Cluster Instance
Updated on 2024-04-01 GMT+08:00
View PDF

Adding Read Replicas to a Cluster Instance

Read replicas are used to enhance read capabilities and reduce the read pressure on primary nodes. After a DDS cluster instance is created, you can create read replicas based on service requirements.

Constraints

  • You can add nodes only when your account balance is greater than or equal to $0 USD. To use this function, contact customer service to apply for the required permission.
  • The cluster instance version must be 3.4.
  • Nodes cannot be added to an instance that is being backed up.
  • An instance cannot be deleted when one or more nodes are being added.
  • The synchronization delay cannot be set. The default value is 0.

Precautions

  • A maximum of five read replicas can be added to a shard node.
  • You can add read replicas to only one shard at a time.

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click in the upper left corner of the page and choose Databases > Document Database Service.
  4. On the Instances page, click the cluster instance name.
  5. In the Node Information area on the Basic Information page, click the shard tab, locate a target shard node, and choose More > Add Read Replicas in the Operation column.

    Figure 1 Node information

  6. On the displayed page, specify Node Class, Nodes, and Parameter Template and click Next.

    Figure 2 Adding read replicas
    Table 1 Parameter description

    Parameter

    Description

    Read Replica Parameter Template

    The parameters that apply to the read replicas of a cluster instance. After a node are created, you can change the parameter template of the node to bring out the best performance.

    NOTE:

    Only whitelisted users can use this function. You need to submit a service ticket to apply for this function. In the upper right corner of the management console, choose Service Tickets > Create Service Ticket to submit a service ticket.

  7. On the displayed page, confirm the node configuration information.

    • If you need to modify your settings, click Previous to go back to the page for you to specify details.
    • If you do not need to modify your settings, click Submit to add nodes.

  8. View the results.

    • When nodes are added, the status of the instance is Adding read replicas. The entire process takes about 15 minutes.
    • In the Node Information area, view the information about the nodes you added.
    • Choose More > View Delay in the Operation column to view the delay of the current node.