DescribeInstanceConfig - 查询实例参数配置

更新时间:2025-03-27 11:42:54

查询云数据库 Tair(兼容 Redis)实例的部分默认配置参数信息。

接口说明

本接口仅支持查询云原生版实例。

说明
若实例为经典版,您可以通过 DescribeParameters 接口进行查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeInstanceConfigget
*全部资源
*

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
InstanceIdstring

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****

返回参数

名称类型描述示例值
名称类型描述示例值
object
Configstring

实例的默认配置参数,更全面的参数配置请调用 Describeparamters 接口。

{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}
RequestIdstring

请求 ID。

4E2C08F6-2D11-4ECD-9A4C-27EF2D3D****
ParamReplModestring

同步模式:

  • async(默认):异步模式
  • semisync:半同步模式
async
ParamReplTimeoutstring

半同步模式的降级阈值。仅半同步支持配置该参数,单位为 ms,取值范围为 10~60000,默认为 500。

说明
当同步延迟超出该阈值时,同步模式会自动转为异步,当同步延迟消除后,同步模式会自动转换为半同步。
500
ParamNoLooseSentinelEnabledstring

哨兵兼容模式,适用于非集群实例。取值说明:

  • no(默认):未开启
  • yes:开启
说明
更多信息请参见 Sentinel 兼容模式
no
ParamSentinelCompatEnablestring

哨兵兼容模式,适用于集群架构代理连接模式或读写分离架构的实例,取值说明:

  • 0(默认):未开启
  • 1:开启
说明
更多信息请参见 Sentinel 兼容模式
0
ParamNoLooseSentinelPasswordFreeAccessstring

开启哨兵模式时,是否允许免密执行 Sentinel 相关命令,取值说明:

  • no(默认):关闭。
  • yes:开启。开启后,可以在任意连接上免密执行 Sentinel 命令以及使用 SENTINEL 命令监听+switch-master 通道。
no
ParamNoLooseSentinelPasswordFreeCommandsstring

启用哨兵模式及 ParamNoLooseSentinelPasswordFreeAccess 参数后,可通过本参数添加额外的免密命令列表(默认为空)。

****

示例

正常返回示例

JSON格式

{
  "Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"list-max-ziplist-entries\\\":512,\\\"list-max-ziplist-value\\\":64,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
  "RequestId": "4E2C08F6-2D11-4ECD-9A4C-27EF2D3D****",
  "ParamReplMode": "async",
  "ParamReplTimeout": "500",
  "ParamNoLooseSentinelEnabled": "no",
  "ParamSentinelCompatEnable": "0",
  "ParamNoLooseSentinelPasswordFreeAccess": "no",
  "ParamNoLooseSentinelPasswordFreeCommands": "****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2025-03-25OpenAPI 描述信息更新查看变更详情
2024-12-11OpenAPI 返回结构发生变更查看变更详情
2024-12-03OpenAPI 返回结构发生变更查看变更详情
2024-11-05OpenAPI 返回结构发生变更查看变更详情
  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史