Clusters
Bearer authentication
response verbosity level.
fullExample: fullPossible values: When true, includes clusters that are marked for deletion
trueExecuted 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"
}
]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"
}Bearer authentication
Filter clusters by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.
["name==my-cluster"]The offset of the first item returned in the collection.
100The maximum number of entries to return.
50ok
Bad request.
unexpected error
GET /api/v1/clusters/minimal HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"clusters": [
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"tenantId": 1001,
"version": "text",
"domain": "text",
"platform": {
"type": "vanilla",
"kubeVersion": "text"
},
"state": "WaitingToConnect",
"ingressClass": "nginx",
"dependenciesStatus": {
"required": {
"ANY_ADDITIONAL_PROPERTY": {
"available": true,
"reason": "text",
"components": "[Circular Reference]"
}
},
"optional": {
"ANY_ADDITIONAL_PROPERTY": {
"available": true,
"reason": "text",
"components": "[Circular Reference]"
}
}
}
}
]
}Bearer authentication
The Universally Unique Identifier (UUID) of the cluster.
9f55255e-11ed-47c7-acef-fc4054768dbcok
The id of the tenant.
1001The cluster's state.
the ingress class that is configured for the cluster
nginxBad request.
The specified resource was not found
unexpected error
GET /api/v1/clusters/{clusterUuid}/minimal HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"tenantId": 1001,
"version": "text",
"domain": "text",
"platform": {
"type": "vanilla",
"kubeVersion": "text"
},
"state": "WaitingToConnect",
"ingressClass": "nginx",
"dependenciesStatus": {
"required": {
"ANY_ADDITIONAL_PROPERTY": {
"available": true,
"reason": "text",
"components": {
"ANY_ADDITIONAL_PROPERTY": {
"available": true,
"reason": "text",
"components": "[Circular Reference]"
}
}
}
},
"optional": {
"ANY_ADDITIONAL_PROPERTY": {
"available": true,
"reason": "text",
"components": {
"ANY_ADDITIONAL_PROPERTY": {
"available": true,
"reason": "text",
"components": "[Circular Reference]"
}
}
}
}
}
}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"
}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
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."
}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: 20Labels to group the returned metrics data by. Grouping availability depends on the selected metric type. Supported values: "category" (workload category) or "node pool".
CategoryPossible values: Filter using the nodepool.
defaultExecuted successfully.
Partial success.
Bad request.
Unauthorized
Forbidden
The specified resource was not found
Unprocessable entity - The request was well-formed but contains semantic errors.
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"
}
],
"groups": [
{
"key": "Nodepool",
"value": "gpu-pool-1"
}
]
}
]
}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"
}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: */*
textBearer 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