All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeInstanceConfig

    Document Center

    Tair (Redis® OSS-Compatible):DescribeInstanceConfig

    Last Updated:Mar 27, 2026

    Queries some of the default configuration parameters for a Tair (Redis-compatible) instance.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    kvstore:DescribeInstanceConfig

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID. You can call the DescribeInstances operation to obtain this ID.

    r-bp1zxszhcgatnx****

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned data.

    Config

    string

    The default configuration parameters of the instance. To view the full list of parameters, call the DescribeParameters operation.

    {\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}
    RequestId

    string

    The request ID.

    4E2C08F6-2D11-4ECD-9A4C-27EF2D3D****
    ParamReplMode

    string

    The replication mode. Valid values:

    • async (default): asynchronous mode

    • semisync: semi-synchronous mode

    async
    ParamReplTimeout

    string

    The degradation threshold for the semi-synchronous mode. This parameter is valid only in semi-synchronous mode. Unit: milliseconds. Valid values: 10 to 60000. Default value: 500.

    Note

    If replication latency exceeds this threshold, the replication mode degrades to asynchronous mode. When the replication latency returns to normal, the mode reverts to semi-synchronous mode.

    500
    ParamNoLooseSentinelEnabled

    string

    Specifies whether to enable Sentinel compatibility mode. This parameter applies only to non-cluster instances. Valid values:

    • no (default): Disabled

    • yes: Enabled

    Note

    For more information, see Sentinel compatibility mode.

    no
    ParamSentinelCompatEnable

    string

    Specifies whether to enable Sentinel compatibility mode. This parameter applies to instances that use the cluster architecture with proxy connection mode or the read/write splitting architecture. Valid values:

    • 0 (default): Disabled

    • 1: Enabled

    Note

    For more information, see Sentinel compatibility mode.

    0
    ParamNoLooseSentinelPasswordFreeAccess

    string

    Specifies whether to allow password-free execution of Sentinel commands when Sentinel compatibility mode is enabled. Valid values:

    • no (default): Disabled.

    • yes: Enabled. Allows you to run Sentinel commands on any connection without a password and use the SENTINEL command to subscribe to the +switch-master channel.

    no
    ParamNoLooseSentinelPasswordFreeCommands

    string

    Additional commands that can be run without a password. This parameter is valid only when Sentinel compatibility mode is enabled and ParamNoLooseSentinelPasswordFreeAccess is set to yes. By default, this parameter is empty.

    ****

    Examples

    Success response

    JSON format

    {
  "Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"list-max-ziplist-entries\\\":512,\\\"list-max-ziplist-value\\\":64,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
  "RequestId": "4E2C08F6-2D11-4ECD-9A4C-27EF2D3D****",
  "ParamReplMode": "async",
  "ParamReplTimeout": "500",
  "ParamNoLooseSentinelEnabled": "no",
  "ParamSentinelCompatEnable": "0",
  "ParamNoLooseSentinelPasswordFreeAccess": "no",
  "ParamNoLooseSentinelPasswordFreeCommands": "****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.