查询云数据库 Tair(兼容 Redis)实例在不同架构和大版本下的参数列表和默认值。
接口说明
调用本接口查询到参数列表和默认值后,您还可以根据业务需求调用 ModifyInstanceConfig 接口修改 Redis 实例的参数。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
kvstore:DescribeParameterTemplates | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CharacterType | string | 是 | logic | |
Engine | string | 是 | 数据库类型,取值固定为 Redis。 | Redis |
EngineVersion | string | 是 | 实例的大版本,取值:4.0、5.0、6.0或7.0。 | 5.0 |
ResourceGroupId | string | 否 | 资源组 ID。您可以通过调用 ListResourceGroups 接口获取资源组 ID。 说明
您也可以通过控制台获取资源组 ID,相关操作,请参见查看资源组基本信息。
| rg-acfmyiu4ekp**** |
InstanceId | string | 否 | 实例 ID,可调用 DescribeInstances 获取。 | r-bp1zxszhcgatnx**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "9DA28D8E-514D-4F12-ADED-70A9C818****",
"Engine": "redis",
"EngineVersion": "5.0",
"ParameterCount": "24",
"Parameters": {
"TemplateRecord": [
{
"CheckingCode": "[yes|no]",
"ParameterName": "appendonly",
"ParameterValue": "yes",
"ForceModify": true,
"ForceRestart": true,
"ParameterDescription": "开启aof持久化模式"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameters.Format | Specified parameters is not valid. | 参数无效 |
403 | ParamNotSupportedForCurrentVersion | Parameter is not supported for current version. | 当前实例版本不支持改参数的修改 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史