Skip to main content
Version: 1.5.1

Cluster

Clusters​

Returns general information about the clusters managed by the YuniKorn Scheduler. The response includes build information about 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 cluster with 1 resource manager.

[
    {
        "startTime": 1697100824863892713,
        "rmBuildInformation": [
            {
                "arch": "amd64",
                "buildDate": "2023-09-04T18:11:43+0800",
                "buildVersion": "latest",
                "coreSHA": "0ecf24d2aad2",
                "goVersion": "1.21",
                "isPluginVersion": "false",
                "rmId": "mycluster",
                "shimSHA": "8b26c373b4b5",
                "siSHA": "e7622cf54e95"
            }
        ],
        "partition": "default",
        "clusterName": "kubernetes"
    }
]

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: .."
}