PIpingcap
cluster parameters

inspect parameters

inspect parameters

post/clusters/{clusterId}/params/inspect

Request

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

Path parameters

clusterIdstring required

clusterId

Request body

instanceIdstring

Response

OK

codeinteger
messagestring

Example response

{
  "data": {
    "params": [
      {
        "parameterInfos": [
          {
            "category": "log",
            "description": "binlog cache size",
            "name": "binlog_cache",
            "note": "binlog cache size",
            "paramId": "1",
            "range": [
              "1",
              " 1000"
            ],
            "rangeType": 1,
            "systemVariable": "log.log_level",
            "unit": "MB",
            "unitOptions": [
              "KB",
              "MB",
              "GB"
            ]
          }
        ]
      }
    ]
  }
}

Changes

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