PIpingcap
cluster upgrade

request for upgrade TiDB cluster

Changed on

request for upgrade TiDB cluster

post/clusters/{clusterId}/upgrade

Request

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

Path parameters

clusterIdstring required

clusterId

Request body

targetVersionstring required
upgradeType'in-place' | 'migration' required
upgradeWay'offline' | 'online'

Example request

{
  "configs": [
    {
      "instanceType": "pd-server",
      "name": "max-merge-region-size",
      "paramId": "1",
      "value": "20"
    }
  ],
  "targetVersion": "v5.0.0"
}

Response

OK

codeinteger
messagestring

Changes