PIpingcap
cluster

query clusters

query clusters

get/clusters/

Request

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

Query parameters

clusterIdstring
clusterNamestring
clusterStatusstring
clusterTagstring
clusterTypestring
pageinteger

Current page location

pageSizeinteger

Number of this request

Response

OK

codeinteger
messagestring

Example response

{
  "data": {
    "clusters": [
      {
        "alertUrl": "http://127.0.0.1:9093",
        "grafanaUrl": "http://127.0.0.1:3000"
      }
    ]
  }
}

Changes

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