You need to enable JavaScript to run this app.
文档中心
缓存数据库 Redis 版

缓存数据库 Redis 版

复制全文
下载 pdf
参数管理
ApplyParameterGroup
复制全文
下载 pdf
ApplyParameterGroup
调用 ApplyParameterGroup 接口将参数模板应用到实例。​
请求类型​
异步请求。​
注意事项​
  • 目标实例的数据库版本需与待应用的参数模板数据库版本一致。例如,参数模板支持的数据库版本为 Redis 6.0,那么该参数模板仅支持应用于 Redis 6.0 版本的实例。​
  • 如果需要应用的参数模板中包含了需要重启的参数,应用该参数模板后实例会重启。重启实例一般需要 30~60 秒完成,中间可能会有 1~2 次闪断,请谨慎操作。建议在业务低峰期执行该操作,并确保应用具备自动重连机制。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
redis-cn0212gzmh2xs****​
实例 ID。​
ParameterGroupId​
String​
是​
pg-cnlfm5yzmxehmkw****​
参数模板 ID。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
ApplyParameterGroupInfo​
请参见返回示例。​
指定参数模板与实例当前参数配置的差异。​
​
InstanceApplyParameterGroupInfo​
​
参数​
类型​
示例值​
描述​
InstanceId​
String​
redis-cn0212gzmh2xs****​
实例 ID。​
ApplyParameters​
Array of ParameterInfo​
请参见返回示例。​
需要应用的参数信息列表。​
ParameterGroupId​
String​
pg-cnlfm5yzmxehmkw****​
参数模板 ID。​
​
ParameterInfo​
​
参数​
类型​
示例值​
描述​
CurrentValue​
String​
100​
参数模板中该参数的运行值。​
Description​
String​
触发内存碎片整理,碎片空间占用量的最小值。单位:MB,取值范围100~1024。​
参数描述。​
NeedReboot​
Boolean​
false​
修改该参数后是否需要重启实例生效。取值范围如下:​
  • true:需要重启。​
  • false:不需要重启。​
Options​
Array of Option​
请参见返回示例。​
选择器类型参数的可选项列表。​
说明​
仅选择器类型(即 Type 为 radio)的参数支持该字段。​
ParamName​
String​
active-defrag-ignore-bytes​
参数名称。​
Range​
String​
[100,1024]​
数值类型参数的取值范围。​
说明​
仅部分数值型(即 Type 为 number)的参数支持该字段。​
Type​
String​
number​
参数类型,取值范围如下:​
  • radio:选择器类型。​
  • number:数值类型。​
  • string:字符串类型。​
Unit​
String​
MB​
数值类型参数的单位。​
说明​
仅部分数值型(即 Type 为 number)的参数支持该字段。​
​
Option​
​
参数​
类型​
示例值​
描述​
Value​
String​
read_primary_node_only​
选择器类型参数的可选项。​
Description​
String​
读请求仅发送到主节点。​
参数的可选项描述。​
​
示例​
请求示例​
​
POST https://redis.cn-beijing.volcengineapi.com/?Action=ApplyParameterGroup&Version=2020-12-07 HTTP/1.1​
Host: redis.cn-beijing.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****",​
"ParameterGroupId": "pg-cnlfm5yzmxehmkw****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "ApplyParameterGroup",​
"Version": "2020-12-07",​
"Service": "Redis",​
"Region": "cn-beijing"​
},​
"Result": {​
"ApplyParameterGroupInfo": {​
"InstanceId": "redis-cn0212gzmh2xs****",​
"ApplyParameters": [​
{​
"CurrentValue": "60",​
"Description": "在发布订阅客户端断开连接之前,输出缓冲区大小持续超过**client-output-buffer-pubsub-soft-limit**参数值的时间。单位:秒,取值范围1~900。",​
"NeedReboot": false,​
"Options": null,​
"ParamName": "client-output-buffer-pubsub-soft-seconds",​
"Range": "[1,900]",​
"TargetValue": "1",​
"Type": "number",​
"Unit": "s"​
}​
],​
"ParameterGroupId": "pg-cnlfm5yzmxehmkw****"​
}​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.09.21 14:58:04
这个页面对您有帮助吗?
有用
有用
无用
无用