Help Center/ GeminiDB/ GeminiDB Redis API/ Working with GeminiDB Redis API/ Parameter Management/ Modifying Parameters of GeminiDB Redis Instances
Updated on 2025-01-03 GMT+08:00

Modifying Parameters of GeminiDB Redis Instances

To ensure optimal GeminiDB Redis performance, you can modify instance parameters based on service requirements.

Precautions

  • You can directly modify parameters on the parameter modification page of an instance.
  • Note that parameter values in default parameter templates cannot be changed.
  • Though parameter values in a default template cannot be changed, you can view details about a default parameter template.
  • If a custom parameter template is set incorrectly, the database startup may fail. You can re-configure the custom parameter template according to the configurations of the default parameter template.

Exercise caution when modifying parameter values to prevent exceptions.

Modifying Parameters of an Instance

  1. Log in to the Huawei Cloud console.
  2. In the service list, choose Databases > GeminiDB Redis API.
  3. In the navigation pane on the left, choose Instances. On the displayed page, locate the instance whose parameters you want to modify and click its name.
  4. In the navigation pane, choose Parameters. On the displayed page, modify parameters listed in Table 1.

    Figure 1 Parameters
    • To save the modifications, click Save.
    • To cancel the modifications, click Cancel.
    • To preview the modifications, click Preview.
      Table 1 GeminiDB Redis instance parameters

      Parameter

      Effective upon Restart

      Default Value

      Value Range

      Description

      Exception

      AuthFailLockTime

      No

      5

      0–10,000

      Authentication failure lock time, in seconds. This parameter specifies the duration during which a suspicious IP address is locked. After the duration expires, the IP address is automatically unlocked.

      GeminiDB Redis instances in Redis Cluster do not support this parameter.

      BigkeysQuantityLimitation

      No

      100

      1–10,000

      Maximum number of big keys of the STRING, HASH, LIST, ZSET, SET, EXHASH, and STREAM data types that can be queried.

      GeminiDB Redis instances in Redis Cluster do not support this parameter.

      CompatibleMode

      No

      3

      0, 1, 2, 3

      Adaptation switch for the StackExchange.Redis client. If StackExchange.Redis reports error "Multiple databases are not supported on this server", change the parameter value to 0.

      GeminiDB Redis instances in Redis Cluster do not support this parameter.

      EnableAclDbDirect

      No

      no

      yes, no

      Whether to enable direct database access The default value is no.

      GeminiDB Redis instances in Redis Cluster do not support this parameter.

      MaxAuthFailTimes

      No

      5

      0–10,000

      Maximum number of authentication attempts permitted per connection. When the number of incorrect password attempts reaches the threshold, the instance will forbid access from a suspicious IP address for a short period of time. 0 indicates this function is disabled.

      GeminiDB Redis instances in Redis Cluster do not support this parameter.

      ProxyTimeout

      No

      0

      0–100,000

      Timeout (in seconds) when a proxy receives no response from a client. When the timeout reaches the threshold, the proxy proactively closes the connection. If the value is 0, the proxy will not proactively disconnect the connection.

      GeminiDB Redis instances in Redis Cluster do not support this parameter.

      enable-acl-direct

      No

      no

      yes, no

      Whether to enable direct database access The default value is no.

      Primary/Standby GeminiDB Redis instances and GeminiDB Redis instances in Redis Cluster do not support this parameter..

      bigkeys-composite-threshold

      No

      1024

      1–2,147,483,647

      If the number of elements in a HASH, LIST, ZSET, SET, or STREAM key is greater than the value of this parameter, the key is identified as a big key. The default value is 1024.

      -

      bigkeys-string-threshold

      No

      102400

      1–2,147,483,647

      If the size of a STRING key is greater than the value of this parameter, the key is determined as a big key. The unit is byte. The default value is 102400.

      -

      databases

      No

      1000

      1–1,000

      Maximum number of supported databases

      -

      key-scan-batch

      No

      5000

      1–2,147,483,647

      Number of keys scanned each time

      -

      maxmemory-policy

      Yes

      noeviction

      noeviction

      Key discarding policy after storage space is used up. GeminiDB Redis instance storage can be scaled up in seconds. After storage space is used up, the instance becomes read-only and its service data is retained. Autoscaling will be available later.

      -

      notify-keyspace-events

      No

      -

      Combination of A, K, E, g, $, l, s, h, z, x, e, and t

      Type of an event to be listened on. The default value is empty, indicating that the parameter does not take effect. Combination of A, K, E, g, $, l, s, h, z, x, e, and t

      -

      slowlog-threshold

      No

      300000

      80,000–100,000,000

      Time threshold (in us) used to define when slow queries are logged on the console. A small value may affect instance performance. You are advised to retain the default value.

      -

  5. After parameters are modified, click Change History to view parameter modification details.

    For details about how to view parameter modification details, see Viewing Parameter Change History.

    After you modify instance parameters, the modifications immediately take effect for the instance.

    Check the value in the Effective upon Restart column.
    • If the value is Yes and the instance status on the Instances page is Parameter change. Pending reboot, you must reboot the instance for the modifications to take effect.
    • If the value is No, the modifications take effect immediately.

Modifying a Custom Parameter Template and Applying It to an Instance

  1. Log in to the Huawei Cloud console.
  2. In the service list, choose Databases > GeminiDB Redis API.
  3. In the navigation pane on the left, choose Parameter Templates.
  4. Click the Custom Templates tab, locate the parameter template you want to modify, and click its name.
  5. Change parameter values as required.

    Figure 2 Editing a parameter template

    • To save the modifications, click Save.
    • To cancel the modifications, click Cancel.
    • To preview the modifications, click Preview.
      Figure 3 Preview Change

  6. After parameters are modified, click Change History to view parameter modification details.

    For details about how to view parameter modification details, see Viewing Parameter Change History.
    • The modifications take effect only after you apply the parameter template to your instance. For details, see Applying a Parameter Template.
    • The change history page displays only the modifications of the last seven days.