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
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeInstanceParams. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of instance parameters |
| InstanceEnumParam | Array of InstanceEnumParam | Instance parameter in Enum type |
| InstanceIntegerParam | Array of InstanceIntegerParam | Instance parameter in Integer type |
| InstanceTextParam | Array of InstanceTextParam | Instance parameter in Char type |
| InstanceMultiParam | Array of InstanceMultiParam | Instance parameter in Multi type |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://redis.tencentcloudapi.com/?Action=DescribeInstanceParams
&InstanceId=crs-5a4py64p
&<Common request parameters>{
"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",
"Status": 2
}
],
"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",
"Status": 2,
"Unit": ""
},
{
"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",
"Status": 2,
"Unit": ""
},
{
"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",
"Status": 2,
"Unit": ""
},
{
"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",
"Status": 2,
"Unit": ""
},
{
"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",
"Status": 2,
"Unit": ""
},
{
"CurrentValue": "4",
"DefaultValue": "0",
"Max": "7200",
"Min": "0",
"NeedRestart": "false",
"ParamName": "timeout",
"Tips": "The connection is closed when the client is idle for the specified length of time, and zero indicates to disable this feature",
"ValueType": "integer",
"Status": 2,
"Unit": ""
},
{
"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",
"Status": 2,
"Unit": ""
},
{
"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",
"Status": 2,
"Unit": ""
}
],
"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",
"Status": 2
}
],
"InstanceMultiParam": [
{
"CurrentValue": "\"\"",
"DefaultValue": "\"\"",
"EnumValue": [
"flushall",
"flushdb",
"keys",
"hgetall",
"eval",
"evalsha",
"script"
],
"NeedRestart": "false",
"ParamName": "disable-command-list",
"Status": 2,
"Tips": "commands in such config will not be allowed to run in this instance,you can config multi commands like this 'flushdb,keys'",
"ValueType": "multi"
}
],
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522",
"TotalCount": 10
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.SystemError | Internal system error, which is irrelevant to the business. |
| FailedOperation.UnSupportError | The instance does not support this API. |
| InternalError.DbOperationFailed | Internal system error with the database operation, which may be update, insert, select, etc. |
| InternalError.InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
| ResourceNotFound.InstanceNotExists | No Redis instance is found by the serialId. |
| ResourceUnavailable.InstanceStatusError | Operation unsupported: the instance is exceptional. |
| UnauthorizedOperation | Unauthorized operation. |
| UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
| UnauthorizedOperation.UserNotInWhiteList | The user is not in the allowlist. |
| UnsupportedOperation.ClusterInstanceAccessedDeny | The Redis cluster edition is not allowed to connect to a security group. |
Was this page helpful?