查询实例参数列表

最近更新时间:2019-08-15 19:56:41

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

查询实例参数列表

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:redis.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceParams
Version String 公共参数,本接口取值:2018-04-12
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例Id

3. 输出参数

参数名称 类型 描述
TotalCount Integer 实例参数个数
InstanceEnumParam Array of InstanceEnumParam 实例枚举类型参数
InstanceIntegerParam Array of InstanceIntegerParam 实例整型参数
InstanceTextParam Array of InstanceTextParam 实例字符型参数
InstanceMultiParam Array of InstanceMultiParam 实例多选项型参数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例参数列表

输入示例

https://redis.tencentcloudapi.com/?Action=DescribeInstanceParams
&InstanceId=crs-5a4py64p
&<公共请求参数>

输出示例

{
  "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": "当系统到达设定的最大内存值后选择内存交换的策略",
        "ValueType": "enum"
      }
    ],
    "InstanceIntegerParam": [
      {
        "CurrentValue": "15001",
        "DefaultValue": "15000",
        "Max": "120000",
        "Min": "15000",
        "NeedRestart": "false",
        "ParamName": "cluster-node-timeout",
        "Tips": "集群模式下当节点在指定时间内(毫秒)不可达则被认为处于失败状态",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "511",
        "DefaultValue": "512",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "hash-max-ziplist-entries",
        "Tips": "当哈希元素数量没有超过指定数目,则编码为内存利用率更高的数据结构存储",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "61",
        "DefaultValue": "64",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "hash-max-ziplist-value",
        "Tips": "当哈希中最大项没有超过指定阈值,则编码为内存利用率更高的数据结构存储",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "511",
        "DefaultValue": "512",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "set-max-intset-entries",
        "Tips": "当集合中的元素全部是64位有符号十进制整数并且未超过设定阈值,则编码为整数集合存储",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "10001",
        "DefaultValue": "10000",
        "Max": "1000000",
        "Min": "-1",
        "NeedRestart": "false",
        "ParamName": "slowlog-log-slower-than",
        "Tips": "超过指定时间的命令将会被记录,负数表示关闭该功能,零值表示强制记录所有命令的执行记录",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "4",
        "DefaultValue": "0",
        "Max": "7200",
        "Min": "0",
        "NeedRestart": "false",
        "ParamName": "timeout",
        "Tips": "客户端空闲指定时长后关闭连接,零值表示关闭该功能",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "121",
        "DefaultValue": "128",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "zset-max-ziplist-entries",
        "Tips": "当有序集合元素数量没有超过指定数目,则编码为内存利用率更高的数据结构存储",
        "ValueType": "integer"
      },
      {
        "CurrentValue": "61",
        "DefaultValue": "64",
        "Max": "10000",
        "Min": "1",
        "NeedRestart": "false",
        "ParamName": "zset-max-ziplist-value",
        "Tips": "当有序集合中最大项没有超过指定阈值,则编码为内存利用率更高的数据结构存储",
        "ValueType": "integer"
      }
    ],
    "InstanceTextParam": [
      {
        "CurrentValue": "\"eK\"",
        "DefaultValue": "\"\"",
        "NeedRestart": "false",
        "ParamName": "notify-keyspace-events",
        "TextValue": [
          "K",
          "E",
          "g",
          "$",
          "l",
          "s",
          "h",
          "z",
          "x",
          "e",
          "A"
        ],
        "Tips": "改变系统已设定客户端的键空间通知方式",
        "ValueType": "text"
      }
    ],
    "RequestId": "e546784b-709c-401d-aba6-73037eb4e522",
    "TotalCount": 10
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
FailedOperation.UnSupportError 实例不支持该接口。
InternalError.DbOperationFailed 统一的 DB 操作错误,可以是 update insert select..。
InternalError.InternalError 内部错误。
InvalidParameter 参数错误
InvalidParameter.PermissionDenied 接口没有cam权限。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
UnauthorizedOperation.UserNotInWhiteList 用户不在白名单中。
UnsupportedOperation.ClusterInstanceAccessedDeny redis 集群版不允许接入安全组。