Read the cloud runner fleet
curl --request GET \
--url https://api.openworklabs.com/v1/admin/runner-fleet \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/runner-fleet"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/admin/runner-fleet', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/admin/runner-fleet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/admin/runner-fleet"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.openworklabs.com/v1/admin/runner-fleet")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/runner-fleet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "not_configured",
"generatedAt": "2023-11-07T05:31:56Z",
"nodes": [
{
"id": "<string>",
"state": "open",
"error": "<string>",
"shedReason": "<string>",
"memory": {
"usedBytes": 4503599627370495,
"limitBytes": 4503599627370495,
"ratio": 50,
"residentBytes": 4503599627370495,
"inUseBytes": 4503599627370495,
"workingSetBytes": 4503599627370495,
"retainedBytes": 4503599627370495,
"heapBytes": 4503599627370495,
"externalBytes": 4503599627370495
},
"cells": {
"resident": 4503599627370495,
"owned": 4503599627370495,
"waitingForRoom": 4503599627370495,
"starting": 4503599627370495,
"residents": [
"<string>"
],
"residentsTruncated": true,
"inMemory": []
},
"sockets": 4503599627370495,
"cpuPercent": 50000,
"moved": {
"handedOff": 4503599627370495,
"rebalanced": 4503599627370495,
"shed": 4503599627370495
},
"isolates": {
"live": 4503599627370495,
"retiring": 4503599627370495
},
"version": "<string>"
}
],
"totals": {
"nodes": 4503599627370495,
"reachable": 4503599627370495,
"closed": 4503599627370495,
"residentCells": 4503599627370495,
"ownedCells": 4503599627370495,
"waitingForRoom": 4503599627370495,
"usedBytes": 4503599627370495
},
"discoveryError": "<string>",
"cellNamesError": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}Admin
Read the cloud runner fleet
Every runner node as it reports itself now: whether it takes new cells, its memory against the cell host’s ceiling, the cells it holds in memory and owns, and cells waiting for room. Read live from each node’s state endpoint; status is not_configured when the deployment does not name the nodes. Counts, sizes and opaque cell ids only.
GET
/
v1
/
admin
/
runner-fleet
Read the cloud runner fleet
curl --request GET \
--url https://api.openworklabs.com/v1/admin/runner-fleet \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/runner-fleet"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/admin/runner-fleet', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/admin/runner-fleet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/admin/runner-fleet"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.openworklabs.com/v1/admin/runner-fleet")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/runner-fleet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "not_configured",
"generatedAt": "2023-11-07T05:31:56Z",
"nodes": [
{
"id": "<string>",
"state": "open",
"error": "<string>",
"shedReason": "<string>",
"memory": {
"usedBytes": 4503599627370495,
"limitBytes": 4503599627370495,
"ratio": 50,
"residentBytes": 4503599627370495,
"inUseBytes": 4503599627370495,
"workingSetBytes": 4503599627370495,
"retainedBytes": 4503599627370495,
"heapBytes": 4503599627370495,
"externalBytes": 4503599627370495
},
"cells": {
"resident": 4503599627370495,
"owned": 4503599627370495,
"waitingForRoom": 4503599627370495,
"starting": 4503599627370495,
"residents": [
"<string>"
],
"residentsTruncated": true,
"inMemory": []
},
"sockets": 4503599627370495,
"cpuPercent": 50000,
"moved": {
"handedOff": 4503599627370495,
"rebalanced": 4503599627370495,
"shed": 4503599627370495
},
"isolates": {
"live": 4503599627370495,
"retiring": 4503599627370495
},
"version": "<string>"
}
],
"totals": {
"nodes": 4503599627370495,
"reachable": 4503599627370495,
"closed": 4503599627370495,
"residentCells": 4503599627370495,
"ownedCells": 4503599627370495,
"waitingForRoom": 4503599627370495,
"usedBytes": 4503599627370495
},
"discoveryError": "<string>",
"cellNamesError": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}Authorizations
denApiKeybearerAuth
Response
The fleet now.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Was this page helpful?