DocsICP FilingConsole
Documentation

Set a whitelist

Updated at:
Copy as MD
Product
My Favorites

After you create a Graph Database (GDB) instance, you must set a whitelist to allow external devices to access it. By default, the whitelist contains only the IP address 127.0.0.1, which prevents all external access.

Background information

  • You must set a whitelist for a target instance before you use it for the first time. After you add IP addresses to the whitelist, the instance endpoint appears on the Basic Information and Database Connection pages.

  • Correctly configured whitelists provide a high level of security for your GDB instance. Maintain your whitelists regularly.

Procedure

  1. Log on to the Graph Database console.

  2. In the upper-left corner of the page, select the region where the instance is located.

  3. Click the Instance ID of the target instance, or click Manage in the Actions column.

  4. In the navigation pane on the left, choose Data Security.

  5. On the Whitelist Settings page, click Modify.

  6. In the Set Whitelist Group dialog box, enter the IP addresses that are allowed to access the GDB instance in the IP Whitelist text box.

    Note

    • The following formats are supported for IP addresses and CIDR blocks:

      • A single IP address, such as 10.23.12.24.

      • 0.0.0.0/0

      • Classless Inter-Domain Routing (CIDR) notation. For example, 10.23.12.24/24. The number 24 indicates the prefix length, which can range from 1 to 32.

    • Separate multiple IP addresses or CIDR blocks with a comma (,).

    • Setting the whitelist to 0.0.0.0/0 or leaving it empty removes all access restrictions. This action poses a high security risk to your GDB instance, so use this setting with caution.

  7. Click OK.

Important

The whitelist settings take effect in about 2 to 3 minutes.

Add or delete a whitelist group

You can add new whitelist groups and delete existing ones, except for the default group.

  • Add a whitelist group

    Note

    You can add a maximum of 10 whitelist groups.

    1. Log on to the Graph Database console.

    2. In the left navigation pane, choose Data Security.

    3. On the Whitelist Settings page, click Add Group.

    4. In the Modify Whitelist Group dialog box, enter a Group Name and the IP Whitelist.

      Note

      • Group Name can contain only lowercase letters, digits, and underscores (_). Chinese characters are not allowed.

      • The IP Whitelist supports IP addresses and CIDR blocks in the following formats.

        • A single IP address, such as 10.23.12.24.

        • 0.0.0.0/0

        • CIDR notation. For example, 10.23.12.24/24. The number 24 indicates the prefix length, which can range from 1 to 32.

      • Separate multiple IP addresses or CIDR blocks with a comma (,).

      • Setting the whitelist to 0.0.0.0/0 or leaving it empty removes all access restrictions. This action poses a high security risk to your GDB instance, so use this setting with caution.

    5. Click OK.

  • Delete a whitelist group

    Note

    The default whitelist group is system-generated and cannot be deleted.

    1. Log on to the Graph Database console.

    2. In the left navigation pane, click Data Security.

    3. On the Whitelist Settings page, find the whitelist group to delete and click Delete on the right.