PIpingcap
cluster parameters

query parameters of a cluster

query parameters of a cluster

get/clusters/{clusterId}/params

Request

  • Base URL
    https://localhost:4100/api/v1
  • URL
    https://localhost:4100/api/v1/clusters/{clusterId}/params
  • Auth
    API key in header Authorization

Path parameters

clusterIdstring required

clusterId

Query parameters

instanceTypestring
pageinteger

Current page location

pageSizeinteger

Number of this request

paramNamestring

Response

OK

codeinteger
messagestring

Example response

{
  "data": {
    "params": [
      {
        "category": "basic",
        "createTime": 1636698675,
        "defaultValue": "1",
        "description": "binlog cache size",
        "hasApply": 1,
        "instanceType": "tidb",
        "name": "binlog_size",
        "note": "binlog cache size",
        "paramId": "1",
        "range": [
          "1",
          " 1000"
        ],
        "rangeType": 1,
        "systemVariable": "log.log_level",
        "unit": "MB",
        "unitOptions": [
          "KB",
          "MB",
          "GB"
        ],
        "updateTime": 1636698675
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.