/
PI
pingcap
/
Azores Open API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
4
Docs
History
Schema
Filter operations
AlertService
30
ApiKeyService
7
AuditService
4
ClusterBRService
6
ClusterParamService
5
ClusterParamTemplateService
9
ClusterService
28
get
/api/v2/clusters
ListClusters retrieves the list of running processes in a cluster
get
/api/v2/clusters/clusterTaskFlow
ClusterTaskFlow
get
/api/v2/clusters/{clusterId}
GetClusters in a cluster
get
/api/v2/clusters/{clusterId}/clusterYaml
ClusterYaml cluster
get
/api/v2/clusters/{clusterId}/nodes
Nodes
post
/api/v2/clusters/{clusterId}/nodes:batchPause
BatchPause cluster
post
/api/v2/clusters/{clusterId}/nodes:batchReload
BatchReload
post
/api/v2/clusters/{clusterId}/nodes:batchRestart
BatchStart cluster
post
/api/v2/clusters/{clusterId}/nodes:batchResume
BatchResume cluster
get
/api/v2/clusters/{clusterId}/sessions
GetProcessList retrieves the list of running processes in a cluster
delete
/api/v2/clusters/{clusterId}/sessions/{sessionId}
DeleteProcess terminates a specific process in the cluster
get
/api/v2/clusters/{clusterId}/topologySummary
TopologySummary
post
/api/v2/clusters/{clusterId}:cancelTaskFlow
Retry cluster
post
/api/v2/clusters/{clusterId}:deployCluster
Deploy cluster
post
/api/v2/clusters/{clusterId}:destroyCluster
DestroyCluster cluster
post
/api/v2/clusters/{clusterId}:offlineCluster
OfflineCluster cluster
post
/api/v2/clusters/{clusterId}:pauseCluster
PauseCluster cluster
post
/api/v2/clusters/{clusterId}:reloadCluster
ReloadCluster cluster
post
/api/v2/clusters/{clusterId}:restartCluster
StartCluster cluster
post
/api/v2/clusters/{clusterId}:resumeCluster
ResumeCluster cluster
post
/api/v2/clusters/{clusterId}:retryTaskFlow
Retry cluster
post
/api/v2/clusters/{clusterId}:scaleInCluster
ScaleInCluster cluster
post
/api/v2/clusters/{clusterId}:scaleOutCluster
ScaleOut cluster
post
/api/v2/clusters:clusterConfig
ClusterConfig
get
/api/v2/clusters:clusterVersions
ClusterVersions cluster
post
/api/v2/clusters:configTemplate
ConfigTemplate cluster
get
/api/v2/clusters:download
HostConfirm one host
post
/api/v2/clusters:takeoverCluster
Takeover cluster
CMServerService
7
CredentialService
8
DiagnosisService
23
DomainService
7
GlobalBRService
11
HostService
16
LicenseService
4
LocationService
5
MetricsService
8
RoleService
4
TagService
12
TaskFlowService
4
TiupsService
8
UserService
11
ClusterService
Copy Markdown
Copied
Copy failed
Changes to OfflineCluster cluster
post
/api/v2/clusters/{clusterId}:offlineCluster
Feb 25, 2025
db29a44ca1ea
Revision changes
○
endpoint added
Ask about this API