Cluster
Clusters
Returns general information about the clusters managed by the YuniKorn Scheduler. Information includes number of (total, failed, pending, running, completed) applications and containers and the build information of resource managers.
URL : /ws/v1/clusters
Method : GET
Auth required : NO
Success response
Code : 200 OK
Content examples
As an example, here is a response from a 2-node cluster with 3 applications and 4 running containers and 1 resource manager.
[
{
"startTime": 1649167576110754000,
"rmBuildInformation": [
{
"buildDate": "2022-02-21T19:09:16+0800",
"buildVersion": "latest",
"isPluginVersion": "false",
"rmId": "rm-123"
}
],
"partition": "default",
"clusterName": "kubernetes",
"totalApplications": "3",
"failedApplications": "1",
"pendingApplications": "",
"runningApplications": "3",
"completedApplications": "",
"totalContainers": "4",
"failedContainers": "",
"pendingContainers": "",
"runningContainers": "4",
"activeNodes": "2",
"totalNodes": "2",
"failedNodes": ""
}
]
Error response
Code : 500 Internal Server Error
Content examples
{
"status_code": 500,
"message": "system error message. for example, json: invalid UTF-8 in string: ..",
"description": "system error message. for example, json: invalid UTF-8 in string: .."
}