All Products
Search
Document Center

ApsaraDB for MongoDB:Configure an IP whitelist template

Last Updated:Mar 28, 2026

IP whitelist templates let you manage access control for multiple ApsaraDB for MongoDB instances from a single place. When you update a template, the changes apply to all associated instances automatically — no need to update each instance's whitelist individually.

Limitations

  • Supported instance types: replica set and sharded cluster instances that use cloud disks only.

  • A template can only be associated with instances in the same region as the template.

  • An instance can be associated with multiple templates.

Create or modify an IP whitelist template

Prerequisites

Before you begin, ensure that you have:

Steps

  1. Log on to the ApsaraDB for MongoDB console.

  2. In the left-side navigation pane, click IP Whitelist Template.

  3. In the upper-left corner, select the target region.

  4. Click Create IP Whitelist Template. To modify an existing template, click Modify in the Actions column.

  5. In the panel that appears, configure the following parameters:

    ParameterDescription
    IP Whitelist Template NameA descriptive name that clearly identifies the template.
    IP Addresses in WhitelistThe IP addresses or CIDR blocks to add. Separate multiple entries with commas (,). Up to 1,000 entries are supported.
    Associate InstanceIn the Available Instances section, click the instances to associate with the template. ApsaraDB for MongoDB adds the template's IP addresses to the whitelists of the selected instances without affecting their existing whitelist settings. To remove an association, click the instance in the Selected Instances section, or use the Whitelist Setting tab on the instance details page.
    Important

    After you disassociate a template from an instance, ApsaraDB for MongoDB removes the IP addresses that are contained in the template from the whitelist of the instance. In this case, the IP addresses cannot be used to connect to the instance. Proceed with caution.

  6. Click OK.

  7. In the confirmation message, click OK.

Delete an IP whitelist template

Before you delete a template, you must disassociate the template from all instances.

  1. Log on to the ApsaraDB for MongoDB console.

  2. In the left-side navigation pane, click IP Whitelist Template.

  3. In the upper-left corner, select the target region.

  4. Find the template and click Delete in the Actions column.

  5. In the confirmation message, click Delete.