Clusters
Use these endpoints to create, manage and delete Run:ai Kubernetes clusters.
Retrieve a list of clusters with details.
Bearer authentication
response verbosity level.
fullExample: fullPossible values: Executed successfully.
The id of the tenant.
1001the timestamp value of when the cluster deletion request was received
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
GET /api/v1/clusters HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"uuid": "A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11",
"name": "example",
"tenantId": 1001,
"domain": "my.company.com",
"status": {},
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-02T00:00:00Z",
"lastLiveness": "2020-01-02T00:00:00Z",
"version": "2.15.0"
}
]Use to create a Kubernetes cluster.
Bearer authentication
Created
The id of the tenant.
1001the timestamp value of when the cluster deletion request was received
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
POST /api/v1/clusters HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"name": "text",
"domain": "text",
"version": "text"
}{
"uuid": "A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11",
"name": "example",
"tenantId": 1001,
"domain": "my.company.com",
"status": {},
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-02T00:00:00Z",
"lastLiveness": "2020-01-02T00:00:00Z",
"version": "2.15.0"
}Retrieve cluster details by Universally Unique Identifier (UUID).
Bearer authentication
The Universally Unique Identifier (UUID) of the cluster.
9f55255e-11ed-47c7-acef-fc4054768dbcresponse verbosity level.
fullExample: fullPossible values: Executed successfully.
The id of the tenant.
1001the timestamp value of when the cluster deletion request was received
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
GET /api/v1/clusters/{clusterUuid} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"uuid": "A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11",
"name": "example",
"tenantId": 1001,
"domain": "my.company.com",
"status": {},
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-02T00:00:00Z",
"lastLiveness": "2020-01-02T00:00:00Z",
"version": "2.15.0"
}Use to update the details of a Kubernetes cluster by Universally Unique Identifier (UUID).
Bearer authentication
The Universally Unique Identifier (UUID) of the cluster.
9f55255e-11ed-47c7-acef-fc4054768dbcNo Content.
No content
Bad request.
Unauthorized
Forbidden
unexpected error
unexpected error
PUT /api/v1/clusters/{clusterUuid} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}No content
Use to delete a cluster by Universally Unique Identifier (UUID). Will return 202 for success if this api was called on a cluster that its version is >=2.20, and force query param is false or not provided. Will return 204 for success if force query param is true, or if cluster is in a version < 2.20
Bearer authentication
The Universally Unique Identifier (UUID) of the cluster.
9f55255e-11ed-47c7-acef-fc4054768dbcif true will force cluster instant deletion otherwise will start cluster graceful deletion process.
falseExample: trueAccepted.
No Content.
Unauthorized
Forbidden
unexpected error
unexpected error
DELETE /api/v1/clusters/{clusterUuid} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"code": 202,
"message": "Request has been accepted."
}Retrieve the metrics data for a Kubernetes cluster by Universally Unique Identifier (UUID).
Bearer authentication
The Universally Unique Identifier (UUID) of the cluster.
9f55255e-11ed-47c7-acef-fc4054768dbcStart date of time range to fetch data in ISO 8601 timestamp format.
2023-06-06T12:09:18.211ZEnd date of time range to fetch data in ISO 8601 timestamp format.
2023-06-07T12:09:18.211ZThe number of samples to take in the specified time range.
20Example: 20Executed successfully.
Partial success.
Bad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
GET /api/v1/clusters/{clusterUuid}/metrics?start=2023-06-06T12%3A09%3A18.211Z&end=2023-06-07T12%3A09%3A18.211Z&metricType=TOTAL_GPU_NODES HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"measurements": [
{
"type": "ALLOCATED_GPU",
"labels": "{'gpu': '3'}",
"values": [
{
"value": "85",
"timestamp": "2023-06-06 12:09:18.211"
}
]
}
]
}Use to retrieve installation instruction for a cluster by Universally Unique Identifier (UUID). Supports clusters version 2.15 or above.
Bearer authentication
The Universally Unique Identifier (UUID) of the cluster.
9f55255e-11ed-47c7-acef-fc4054768dbcThe cluster version to install
2.16The remote URL of the runai cluster
https://cluster.runaiExecuted successfully.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
GET /api/v1/clusters/{clusterUuid}/cluster-install-info?version=2.16 HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"installationStr": "helm update --update repo/runai-cluster -n runai --set cluster.url=test_cluster",
"repositoryName": "runai",
"chartRepoURL": "https://runai.jfrog.io/artifactory/charts",
"clientSecret": "ABC333DDD"
}Retrieve the installation values file of a cluster by Retrieve the installation values file of a given cluster by ID. Supports clusters 2.13 and lower.
Bearer authentication
Unique identifier of the cluster.
Cloud type identifier.
Comma-separated list of IP addresses that provide access to the cluster.
Format of the output file.
yamlPossible values: OK
Unauthorized
The specified resource was not found
GET /v1/k8s/clusters/{cluster_uuid}/installfile HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textGet current cluster metrics. If time range query parameters supplied, then historical data will be returned as well. Deprecated - please use api/v1/clusters/{clusterUuid}/metrics
Bearer authentication
The Universally Unique Identifier (UUID) of the cluster.
9f55255e-11ed-47c7-acef-fc4054768dbcStart of time range to fetch data from in UTC format.
2023-06-06 12:09:18.211End of time range to fetch data from in UTC format.
2023-06-07 12:09:18.211The number of samples to take in the specified time range.
20Example: 20Filter by unique nodepool name.
defaultA Clusters metrics
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
GET /v1/k8s/clusters/{clusterUuid}/metrics HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"metadata": {
"clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
"clusterName": "cluster-a"
},
"current": {
"resources": [
{
"numberOfPendingWorkloads": 1,
"gpu": {
"quota": 3,
"allocated": 2.5,
"utilization": 0.765
},
"cpu": {
"quota": 3,
"allocated": 2.5,
"utilization": 0.765
},
"memory": {
"quota": 3,
"allocated": 2.5,
"utilization": 0.765
},
"nodepoolName": "nodepoola"
}
],
"projectResources": [
{
"numberOfPendingWorkloads": 1,
"gpu": {
"quota": 3,
"allocated": 2.5,
"utilization": 0.765
},
"cpu": {
"quota": 3,
"allocated": 2.5,
"utilization": 0.765
},
"memory": {
"quota": 3,
"allocated": 2.5,
"utilization": 0.765
},
"projectName": "project-a",
"departmentName": "default",
"nodepoolName": "nodepoola"
}
]
},
"timeRange": {
"resources": [
{
"numberOfPendingWorkloads": 1,
"gpu": {
"quota": 3,
"allocated": 2.5,
"utilization": 0.765
},
"cpu": {
"quota": 3,
"allocated": 2.5,
"utilization": 0.765
},
"memory": {
"quota": 3,
"allocated": 2.5,
"utilization": 0.765
},
"timestamp": "2023-06-06T12:09:18.211Z"
}
]
}
}Last updated