DescribeInstanceParams

Last updated: 2019-09-09 12:20:59

1. API Description

API domain name: redis.tencentcloudapi.com.

This API queries the list of instance parameters.

Default API request rate limit: 20 requests/sec.

Note: This API supports financial availability zones. Because financial availability zones and non-financial availability zones are isolated, if the common parameter Region specifies a financial availability zone (e.g., ap-shanghai-fsi), you need to specify a domain name with the financial availability zone as well, which preferably in the same region as the specified Region, for example: vod.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: DescribeInstanceParams
Version Yes String Common parameter; the version of this API: 2018-04-12
Region Yes String Common parameters; for details, see the List of Regions supported by the product.
InstanceId Yes String Instance ID

3. Output Parameters

Parameter name Type Description
TotalCount Integer Number of instance parameters
InstanceEnumParam Array of InstanceEnumParam Enumeration parameters of the instance
InstanceIntegerParam Array of InstanceIntegerParam Integer parameters of the instance
InstanceTextParam Array of InstanceTextParam Text parameters of the instance
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Querying the List of Instance Parameters

Input Sample Code

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

Output Sample Code

{
  "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

API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

TCCLI

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.SystemError Internal system error, irrelevant to the business.
FailedOperation.UnSupportError The instance does not support this API.
InternalError.DbOperationFailed Internal database operation (e.g., update, insert, or select) errors.
InternalError.InternalError Internal error.
InvalidParameter Parameter error
InvalidParameter.PermissionDenied The API has no CAM permissions.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.NoCAMAuthed The operation performed is not authorized by CAM.
UnauthorizedOperation.UserNotInWhiteList The user is not on the whitelist.
UnsupportedOperation.ClusterInstanceAccessedDeny The Redis cluster mode is not allowed to access a security group.