DescribeDBInstanceParams--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceParams

最近更新时间：2024.07.18 22:55:09首次发布时间：2021.11.15 16:07:16

调用 DescribeDBInstanceParams 接口查询目标 Redis 实例支持配置的参数列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
PageNumber	Integer	是	1	参数信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	是	1	每页记录数。取值为 1~100 间的整数。

返回参数

参数	类型	示例值	描述
Params	Object[]		配置参数信息列表。说明 Redis 实例支持的参数详情，请参见参数支持。
TotalParamsNum	Integer	33	总的配置参数数量。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeDBInstanceParams&Version=2020-12-07 HTTP/1.1
Host: redis.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
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024071619492773617F0DF933C71F28F2-d1f478",
        "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
    }
}

错误码

更多详情，请参见错误码。