PIpingcap
cluster upgrade

query config diff between current cluster and target upgrade version

Changed on

query config diff between current cluster and target upgrade version

get/clusters/{clusterId}/upgrade/diff

Request

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

Path parameters

clusterIdstring required

clusterId

Query parameters

targetVersionstring required

Response

OK

codeinteger
messagestring

Example response

{
  "data": {
    "configDiffInfos": [
      {
        "category": "basic",
        "currentValue": "20",
        "description": "desc for max-merge-region-size",
        "instanceType": "pd-server",
        "name": "max-merge-region-size",
        "paramId": "1",
        "range": [
          "1",
          " 1000"
        ],
        "rangeType": 1,
        "suggestValue": "30",
        "unit": "MB",
        "unitOptions": [
          "KB",
          "MB",
          "GB"
        ]
      }
    ]
  }
}

Changes