DescribeInstanceParams

1. API Description

Domain name for API request: redis.tencentcloudapi.com.

This API is used to query the list of instance parameters.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Querying the List of Instance Parameters

Input Example

https://redis.tencentcloudapi.com/?Action=DescribeInstanceParams
&InstanceId=crs-5a4py64p
&<common request parameters>

Output Example

{
  "Response": {
    "InstanceEnumParam": [
      {
        "CurrentValue": "volatile-ttl",
        "DefaultValue": "noeviction",
        "EnumValue": [
          "volatile-lru",
          "allkeys-lru",
          "volatile-random",
          "allkeys-random",
          "volatile-ttl",
          "noeviction"
        ],
        "NeedRestart": "false",
        "ParamName": "maxmemory-policy",
        "Tips": "Select the memory swapping policy when the system reaches the set maximum memory value",
        "ValueType": "enum"
      }
    ],
    "InstanceIntegerParam": [
      {
        "CurrentValue": "15001",
        "DefaultValue": "15000",
        "Max": "120000",
        "Min": "15000",
        "NeedRestart": "false",
        "ParamName": "cluster-node-timeout",
        "Tips": "In cluster mode, a node is considered to fail if it is unreachable within the specified time period (in milliseconds)",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "511",
        "DefaultValue": "512",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "hash-max-ziplist-entries",
        "Tips": "If the number of hash entries does not exceed the specified number, the hashes are encoded using a memory efficient data structure",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "61",
        "DefaultValue": "64",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "hash-max-ziplist-value",
        "Tips": "If the largest item in the hashes does not exceed the specified threshold, the hashes are encoded using a memory efficient data structure",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "511",
        "DefaultValue": "512",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "set-max-intset-entries",
        "Tips": "If all the elements in the set are 64-bit signed decimal integers and do not exceed the set threshold, the hashes are encoded as an integer set",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "10001",
        "DefaultValue": "10000",
        "Max": "1000000",
        "Min": "-1",
        "NeedRestart": "false",
        "ParamName": "slowlog-log-slower-than",
        "Tips": "Commands that exceed the specified time period of execution will be logged; a negative number indicates to disable this feature, and zero indicates to compulsorily log the executions of all commands",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "4",
        "DefaultValue": "0",
        "Max": "7200",
        "Min": "0",
        "NeedRestart": "false",
        "ParamName": "timeout",
        "Tips": "The connection is closed after the client is idle for the specified length of time, and zero indicates to disable this feature",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "121",
        "DefaultValue": "128",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "zset-max-ziplist-entries",
        "Tips": "If the number of ordered set elements does not exceed the specified number, the hashes are encoded using a memory efficient data structure",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "61",
        "DefaultValue": "64",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "zset-max-ziplist-value",
        "Tips": "If the largest item in the ordered set does not exceed the specified threshold, the hashes are encoded using a memory efficient data structure",
        "ValueType": "integer"
      }
    ],
    "InstanceTextParam": [
      {
        "CurrentValue": "\"eK\"",
        "DefaultValue": "\"\"",
        "NeedRestart": "false",
        "ParamName": "notify-keyspace-events",
        "TextValue": [
          "K",
          "E",
          "g",
          "$",
          "l",
          "s",
          "h",
          "z",
          "x",
          "e",
          "A"
        ],
        "Tips": "Change the notification method of the client key space set by the system",
        "ValueType": "text"
      }
    ],
    "RequestId": "e546784b-709c-401d-aba6-73037eb4e522",
    "TotalCount": 10
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

• API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.