Sign in

v1

latestSwagger 2.0Apache 2.02026-07-17113236428.7 KB
parameter group

create a parameter group

create a parameter group

post/param-groups/

Request body

clusterSpecstring required
clusterVersionstring required
dbType1 | 2 required
groupType1 | 2 required
namestring required
notestring

Example request

{
  "addParams": [
    {
      "category": "log",
      "defaultValue": "1024",
      "description": "binlog size",
      "hasApply": 1,
      "instanceType": "TiDB",
      "name": "binlog_size",
      "rangeType": 1,
      "systemVariable": "log.binlog_size",
      "unit": "MB",
      "unitOptions": [
        "KB",
        "MB",
        "GB"
      ]
    }
  ],
  "clusterSpec": "8C16G",
  "clusterVersion": "v5.0",
  "dbType": 1,
  "groupType": 1,
  "name": "8C16GV4_default",
  "note": "default param group",
  "params": [
    {
      "defaultValue": "1",
      "note": "binlog cache size",
      "paramId": "123"
    }
  ]
}

Response

OK

codeinteger
messagestring

Example response

{
  "data": {
    "paramGroupId": "1"
  }
}