You need to enable JavaScript to run this app.
Cache for Redis

Cache for Redis

  • Documentation
    • Cache for RedisDevelopment reference (Control plane)API referenceParameter managementDescribeDBInstanceParams
Copy page
Download PDF
Parameter management
DescribeDBInstanceParams
Copy page
Download PDF
DescribeDBInstanceParams

Call the DescribeDBInstanceParams API to query the configuration parameters of a specified Redis instance.

Request type

Synchronous request.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
redis-cn0212gzmh2xs****

Instance ID.

tip

You can call DescribeDBInstances to query the basic information of all Redis instances in a target region, including instance IDs.

PageNumber
Integer
Yes
1
The page number of the parameter information list. The value must be from 1 to the max value of the Integer data type.
PageSize
Integer
Yes
1
The number of records per page. This value must be an integer between 1 and 1000.

Response parameters

Name
Type
Example
Description
Params
Object[]

Information list of parameters.

tip

For more information on parameters supported by Redis instances, refer to Supported parameters.

TotalParamsNum
Integer
33
Total number of parameters.

Sample request 

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceParams&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****",
    "PageNumber": 1,
    "PageSize": 1
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "2024071619492773617F0DF933C71F28F2-d1****",
        "Action": "DescribeDBInstanceParams",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-shanghai"
    },
    "Result": {
        "Params": [
            {
                "CurrentValue": "25",
                "DefaultValue": "25",
                "Description": "内存碎片整理占用的最大CPU百分比。取值范围1～40。",
                "EditableForInstance": true,
                "NeedReboot": false,
                "Options": null,
                "ParamName": "active-defrag-cycle-max",
                "Range": "[1,40]",
                "Type": "number",
                "Unit": ""
            }
        ],
        "TotalParamsNum": 33
    }
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.07.02 15:43:26