Configure an IP whitelist template

Updated at: 2024-03-18 03:18

This topic describes the scenarios of the IP whitelist template feature provided by ApsaraDB for MongoDB. This topic also describes how to use the feature.

Scenarios

If you want an IP address whitelist to be applied across multiple ApsaraDB for MongoDB instances, you can create an IP address whitelist template and associate the template with these instances. This way, when you want to modify the whitelists of these instances, you only need to modify the template.

Usage notes

  • The IP whitelist template feature can be enabled only for replica set or sharded cluster instances that use cloud disks.

  • You can associate a template only with instances that reside within the same region as the template. An instance can be associated with multiple templates.

Create and modify an IP whitelist template

  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 of the page, select a region.

  4. In the upper-left corner of the page, click Create IP Whitelist Template.

    If an existing template is available, you can click Modify in the Actions column.

  5. In the panel that appears, configure the parameters described in the following table.

    Parameter

    Description

    Parameter

    Description

    IP Whitelist Template Name

    The name of the template. We recommend that you specify a descriptive name that clearly identifies the template.

    IP Addresses in Whitelist

    The IP addresses or CIDR blocks that you want to add to the template. Separate multiple items with commas (,). Up to 1,000 items can be added.

    Associate Instance

    In the Available Instances section, click the instances with which you want to associate the template.

    Note

    After you associate the template with these instances, ApsaraDB for MongoDB adds the IP addresses that are contained in the template to the whitelists of the instances. This does not affect the existing whitelist settings of these instances.

    In the Selected Instances section, you can click an instance to disassociate the template from the instance. You can also disassociate a template from an instance on the Whitelist Setting tab in the console.

    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 message that appears, click OK.

Delete an IP whitelist template

You can delete an IP whitelist template as needed. Before you delete a template, you must disassociate the template from 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 of the page, select a region.

  4. On the IP Whitelist Template page, find the IP whitelist template that you want to delete and then click Delete in the Actions column.

  5. In the message that appears, click Delete.

  • On this page (1, T)
  • Scenarios
  • Usage notes
  • Create and modify an IP whitelist template
  • Delete an IP whitelist template
Feedback
phone Contact Us