You need to enable JavaScript to run this app.
导航
DescribeDBInstanceParams
最近更新时间:2023.08.07 16:30:07首次发布时间:2021.11.15 16:07:16

调用 DescribeDBInstanceParams 接口查询指定 Redis 实例的配置参数信息。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

InstanceId

String

redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

PageNumberInteger1参数信息列表的页码,取值为不超过 Integer 数据类型的最大值,起始值为 1。
PageSizeInteger1每页记录数。取值为 1~100 间的整数。

返回数据

名称类型示例值描述
TotalParamsNumInteger30总的配置参数数量。

Params

Array of ParamInfo

请参见返回示例

配置参数信息列表。关于 ParamInfo 的详细说明,请参见数据结构

说明

Redis 实例支持的参数详情,请参见参数支持

请求示例

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": "202204151820200102120972071663****",
          "Action": "DescribeDBInstanceParams",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": {
          "Params": [
               {
                "CurrentValue": "5000",
                "DefaultValue": "5000",
                "Description": "一个Lua脚本的最长执行时间。单位:毫秒,取值范围0~5000,0表示无限执行时间。",
                "EditableForInstance": true,
                "NeedReboot": false,
                "Options": null,
                "ParamName": "lua-time-limit",
                "Range": "[0,5000]",
                "Type": "number",
                "Unit": "ms"
            },
          ],
          "TotalParamsNum": 29
     }
}

错误码

更多详情,请参见错误码