获取系统参数列表
更新时间：2023-09-08
请求说明
系统参数列表，包含全量的系统参数数据；创建参数模版时可从中选取需要的参数，需要注意不同引擎和引擎版本的支持。
请求结构
GET /v2/template/system?engine={engine}&engineVersion={engineVersion}&clusterType={clusterType} HTTP/1.1
Host: redis.{region}.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| engine | String | 否 | URL参数 | 引擎，可选值：redis |
| engineVersion | String | 否 | URL参数 | 引擎版本，示例：5.0 |
| clusterType | String | 否 | URL参数 | 集群类型，可选值：master_slave，cluster |
返回头域
除公共头域外，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否成功 |
| result | List<Result> | 系统参数列表 |
Result参数信息
| 参数名称 | 类型 | 描述 |
|---|---|---|
| confName | String | 参数名称 |
| confDefault | String | 参数默认值 |
| confValue | String | 参数值 |
| confType | Integer | 参数类型（1:单选类型 2.数字类型 3.多选类型 4.多选类型，单值） |
| confRange | String | 参数范围： 当confType=1时，以逗号（，）为分割符所有选择项； 当confType=2时，以逗号（，）为分割符，第一项为范围最小值，第二项为范围最大值； 当confType=3，以逗号（，）为间隔符所有可选项； 当confType=4时，以逗号（，）为间隔符所有可选项； |
| confModule | Integer | 1:redis 2:proxy 3.redis+proxy 4.metaserver |
| confDesc | String | 配置对用户展示含义(转码后的一串字符) |
| needReboot | Integer | 该参数是否需要重启，0：不需要，1：需要 |
| confRedisVersion | String | 参数对应的redis版本。例如：2.6、3.2、 4.0、5.0、 all(所有版本都适配) |
| confCacheVersion | Integer | 生效redis version（和VERSION_TYPE保持一致） |
请求示例
GET /v2/template/system?engine=redis&engineVersion=5.0&clusterType=cluster HTTP/1.1
HOST: redis.bj.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
{
"success": true,
"result": [
{
"confName": "qpsquota",
"confDefault": "100000",
"confValue": null,
"confType": 2,
"confRange": "0-500000",
"confModule": 2,
"confDesc": "cmVzdHJpY3Rpb25zIG9uIGVhY2ggcHJveHkgcXBz",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 5001
},
{
"confName": "rqpsquota",
"confDefault": "100000",
"confValue": null,
"confType": 2,
"confRange": "0-500000",
"confModule": 2,
"confDesc": "cXVvdGEgb24gZWFjaCBwcm94eSBxcHMgb2YgcmVhZA==",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 5001
},
{
"confName": "wqpsquota",
"confDefault": "100000",
"confValue": null,
"confType": 2,
"confRange": "0-500000",
"confModule": 2,
"confDesc": "cXVvdGEgb24gZWFjaCBwcm94eSBxcHMgb2Ygd3JpdGU=",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 5001
},
{
"confName": "stale_slave_readable",
"confDefault": "false",
"confValue": null,
"confType": 2,
"confRange": "true|false",
"confModule": 2,
"confDesc": "c3RhbGUgcmVhZGFibGUgb24gcHJveHk=",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 5001
},
{
"confName": "appendonly",
"confDefault": "yes",
"confValue": null,
"confType": 1,
"confRange": "yes|no|partial",
"confModule": 1,
"confDesc": "5piv5ZCm5ZCv55SoIEFPRiDmjIHkuYXljJY=",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "maxmemory-policy",
"confDefault": "volatile-ttl",
"confValue": null,
"confType": 1,
"confRange": "volatile-lru|allkeys-lru|volatile-random|allkeys-random|volatile-ttl|volatile-lfu|allkeys-lfu|noeviction",
"confModule": 1,
"confDesc": "5b2T5YaF5a2Y6LaF6YeP5pe255qE6ZSu5reY5rGw562W55Wl44CC5Y+v6YCJOjxici8+dm9sYXRpbGUtbHJ177ya5Y+q5LuO5bey6K6+572u6L+H5pyf5pe26Ze055qE5pWw5o2u6ZuG5Lit5oyR6YCJ5pyA6L+R5pyA5bCR5L2/55So55qE5pWw5o2u5reY5rGwPGJyLz5hbGxrZXlzLWxyde+8muaMkemAieacgOi/keacgOWwkeS9v+eUqOeahOaVsOaNrua3mOaxsDxici8+dm9sYXRpbGUtcmFuZG9t77ya5Y+q5LuO5bey6K6+572u6L+H5pyf5pe26Ze055qE5pWw5o2u6ZuG5Lit5Lu75oSP6YCJ5oup5pWw5o2u5reY5rGwPGJyLz5hbGxrZXlzLXJhbmRvbe+8muS7u+aEj+mAieaLqeaVsOaNrua3mOaxsDxici8+dm9sYXRpbGUtdHRs77ya5Y+q5LuO5bey6K6+572u6L+H5pyf5pe26Ze055qE5pWw5o2u6ZuG5Lit5oyR6YCJ5bCG6KaB6L+H5pyf55qE5pWw5o2u5reY5rGwPGJyLz5ub2V2aWN0aW9u77ya5LiN6L+b6KGM5pWw5o2u5reY5rGwPGJyLz52b2xhdGlsZS1sZnU6IOS7juaJgOaciemFjee9ruS6hui/h+acn+aXtumXtOeahOmUruS4rempsemAkOS9v+eUqOmikeeOh+acgOWwkeeahOmUrjxici8+YWxsa2V5cy1sZnU6IOS7juaJgOaciemUruS4rempsemAkOS9v+eUqOmikeeOh+acgOWwkeeahOmUrg==",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "hash-max-ziplist-entries",
"confDefault": "512",
"confValue": null,
"confType": 2,
"confRange": "0-999999999999999",
"confModule": 1,
"confDesc": "5b2TIGhhc2gg5a+56LGh5ZCM5pe25ruh6Laz5Lul5LiL5Lik5Liq5p2h5Lu25pe277yMIGhhc2gg5a+56LGh5L2/55SoIHppcGxpc3Qg57yW56CB77yaPGJyLz4xLiBoYXNoIOWvueixoeS/neWtmOeahOmUruWAvOWvueaVsOmHj+Wwj+S6juaIluiAheetieS6jiBoYXNoLW1heC16aXBsaXN0LWVudHJpZXMg5Y+C5pWw5YC8PGJyLz4yLiBoYXNoIOWvueixoeS/neWtmOeahOaJgOaciemUruWAvOWvueeahOmUruWSjOWAvOeahOWtl+espuS4sumVv+W6pumDveWwj+S6juaIluiAheetieS6jiBoYXNoLW1heC16aXBsaXN0LXZhbHVlIOWPguaVsOWAvA==",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "hash-max-ziplist-value",
"confDefault": "64",
"confValue": null,
"confType": 2,
"confRange": "0-999999999999999",
"confModule": 1,
"confDesc": "5b2TIGhhc2gg5a+56LGh5ZCM5pe25ruh6Laz5Lul5LiL5Lik5Liq5p2h5Lu25pe277yMIGhhc2gg5a+56LGh5L2/55SoIHppcGxpc3Qg57yW56CB77yaPGJyLz4xLiBoYXNoIOWvueixoeS/neWtmOeahOmUruWAvOWvueaVsOmHj+Wwj+S6juaIluiAheetieS6jiBoYXNoLW1heC16aXBsaXN0LWVudHJpZXMg5Y+C5pWw5YC8PGJyLz4yLiBoYXNoIOWvueixoeS/neWtmOeahOaJgOaciemUruWAvOWvueeahOmUruWSjOWAvOeahOWtl+espuS4sumVv+W6pumDveWwj+S6juaIluiAheetieS6jiBoYXNoLW1heC16aXBsaXN0LXZhbHVlIOWPguaVsOWAvA==",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "set-max-intset-entries",
"confDefault": "512",
"confValue": null,
"confType": 2,
"confRange": "0-999999999999999",
"confModule": 1,
"confDesc": "5b2TIHNldCDlr7nosaHlkIzml7bmu6HotrPku6XkuIvkuKTkuKrmnaHku7bml7bvvIwgc2V0IOWvueixoeS9v+eUqCBpbnRzZXQg57yW56CB77yaPGJyLz4xLiBzZXQg5a+56LGh5Lit55qE5YWD57Sg5pWw6YeP5bCP5LqO5oiW6ICF562J5LqOIHNldC1tYXgtaW50c2V0LWVudHJpZXMg5Y+C5pWw5YC8PGJyLz4yLiBzZXQg5a+56LGh5Lit55qE5omA5pyJ5YWD57Sg6YO95pivIDY0IOS9jeacieespuWPt+WNgei/m+WItuaVtOaVsA==",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "zset-max-ziplist-entries",
"confDefault": "128",
"confValue": null,
"confType": 2,
"confRange": "0-999999999999999",
"confModule": 1,
"confDesc": "5b2TIHpzZXQg5a+56LGh5ZCM5pe25ruh6Laz5Lul5LiL5Lik5Liq5p2h5Lu25pe277yMenNldCDlr7nosaHkvb/nlKggemlwbGlzdCDnvJbnoIHvvJo8YnIvPjEuIHpzZXQg5a+56LGh5L+d5a2Y55qE6ZSu5YC85a+55pWw6YeP5bCP5LqO5oiW6ICF562J5LqOIHpzZXQtbWF4LXppcGxpc3QtZW50cmllcyDlj4LmlbDlgLw8YnIvPjIuIHpzZXQg5a+56LGh5L+d5a2Y55qE5omA5pyJ6ZSu5YC85a+555qE6ZSu5ZKM5YC855qE5a2X56ym5Liy6ZW/5bqm6YO95bCP5LqO5oiW6ICF562J5LqOIHpzZXQtbWF4LXppcGxpc3QtdmFsdWUg5Y+C5pWw5YC8",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "zset-max-ziplist-value",
"confDefault": "64",
"confValue": null,
"confType": 2,
"confRange": "0-999999999999999",
"confModule": 1,
"confDesc": "5b2TIHpzZXQg5a+56LGh5ZCM5pe25ruh6Laz5Lul5LiL5Lik5Liq5p2h5Lu25pe277yMenNldCDlr7nosaHkvb/nlKggemlwbGlzdCDnvJbnoIHvvJo8YnIvPjEuIHpzZXQg5a+56LGh5L+d5a2Y55qE6ZSu5YC85a+55pWw6YeP5bCP5LqO5oiW6ICF562J5LqOIHpzZXQtbWF4LXppcGxpc3QtZW50cmllcyDlj4LmlbDlgLw8YnI+Mi4genNldCDlr7nosaHkv53lrZjnmoTmiYDmnInplK7lgLzlr7nnmoTplK7lkozlgLznmoTlrZfnrKbkuLLplb/luqbpg73lsI/kuo7miJbogIXnrYnkuo4genNldC1tYXgtemlwbGlzdC12YWx1ZSDlj4LmlbDlgLw=",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "notify-keyspace-events",
"confDefault": "",
"confValue": null,
"confType": 4,
"confRange": "K|E|g|$|l|s|h|z|x|e|A",
"confModule": 1,
"confDesc": "5a6i5oi356uv5Y+v5Lul5Yip55So6ZSu56m66Ze06YCa55+l5p2l5o6l5pS26YKj5Lqb5b2x5ZONIFJlZGlzIOaVsOaNrumbhueahOS6i+S7tumAmuefpe+8jG5vdGlmeS1rZXlzcGFjZS1ldmVudHMg5Y+C5pWw5oyH5a6a5LqG5o6l5pS26YCa55+l55qE57G75Z6L44CC5Y+C5pWw5YC85Y+v55Sx5aSa5Liq5a2X56ym57uE5oiQ77yM56m65YC86KGo56S656aB55So6YCa55+l44CC5ZCE5a2X56ym5ZCr5LmJ5aaC5LiL77yaPGJyLz5L77ya6ZSu56m66Ze05LqL5Lu2PGJyLz5F77ya6ZSu5LqL5Lu25LqL5Lu2PGJyLz5n77ya6YCa55So5ZG95Luk77yI6Z2e54m55a6a57G75Z6L77yJ77yM5L6L5aaCIERFTOOAgSBFWFBJUkXjgIEgUkVOQU1FIOetiTxici8+JO+8muWtl+espuS4suWRveS7pDxici8+bO+8muWIl+ihqOWRveS7pDxici8+c++8mumbhuWQiOWRveS7pDxici8+aO+8muWTiOW4jOWRveS7pDxici8+eu+8muacieW6j+mbhuWQiOWRveS7pDxici8+eO+8mumUrui/h+acn+S6i+S7tjxici8+Ze+8mumUrua3mOaxsOS6i+S7tjxici8+Qe+8muWPguaVsCBnJGxzaHp4ZSDnmoTliKvlkI3vvIzlm6DmraQgIkFLRSIg5a2X56ym5Liy6KGo56S65omA5pyJ55qE5LqL5Lu2",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 7001
},
{
"confName": "timeout",
"confDefault": "0",
"confValue": null,
"confType": 2,
"confRange": "0-100000",
"confModule": 1,
"confDesc": "5pat5byA56m66Zey5a6i5oi356uv5LmL5YmN562J5b6F55qE56eS5pWw44CC6Zu25YC86KGo56S65LuO5LiN5pat5byA56m66Zey5a6i5oi356uv",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "hz",
"confDefault": "10",
"confValue": null,
"confType": 2,
"confRange": "1-500",
"confModule": 1,
"confDesc": "6K6+572uIFJlZGlzIOWQjuWPsOS7u+WKoeaJp+ihjOmikeeOh++8jOavlOWmgua4hemZpOi/h+acn+mUruS7u+WKoeOAguWPguaVsOWAvOi2iuWkp++8jENQVSDmtojogJfotorlpKfvvIzlu7bov5/otorlsI/vvIzlu7rorq7kuI3opoHotoXov4cgMTAw",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "disable_commands",
"confDefault": "flushall,flushdb",
"confValue": null,
"confType": 3,
"confRange": "flushall|flushdb|keys|hgetall",
"confModule": 1,
"confDesc": "55So5oi36Ieq5a6a5LmJ56aB55So5ZG95Luk",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 10001
},
{
"confName": "support_multi_active",
"confDefault": "no",
"confValue": null,
"confType": 1,
"confRange": "yes|no",
"confModule": 1,
"confDesc": "bXVsdGkgYWN0aXZlIG9wdGlvbg==",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 5001
},
{
"confName": "user_filter_cmds",
"confDefault": "",
"confValue": null,
"confType": 4,
"confRange": "set|del",
"confModule": 1,
"confDesc": "dXNlciBmaWx0ZXIgY21kcw==",
"needReboot": 0,
"confRedisVersion": "all",
"confCacheVersion": 5001
},
{
"confName": "use-op-header",
"confDefault": "no",
"confValue": null,
"confType": 2,
"confRange": "yes|no",
"confModule": 1,
"confDesc": "dXNlIG9wLWhlYWRlcg==",
"needReboot": 0,
"confRedisVersion": "4.0",
"confCacheVersion": 10001
}
]
}