Retrieve detailed per-instance-type machine stats for a site

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/machine/instance-type/stats

GET

/v2/org/:org/nico/machine/instance-type/stats

$ curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/machine/instance-type/stats \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d siteId=siteId

1 [
2   {
3     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4     "name": "NVIDIA A100 40GB",
5     "assignedMachineStats": {
6       "total": 50,
7       "initializing": 3,
8       "ready": 20,
9       "inUse": 22,
10       "error": 2,
11       "maintenance": 2,
12       "unknown": 1
13     },
14     "allocated": 44,
15     "maxAllocatable": 6,
16     "usedMachineStats": {
17       "total": 44,
18       "initializing": 0,
19       "ready": 0,
20       "inUse": 42,
21       "error": 1,
22       "maintenance": 1,
23       "unknown": 0
24     },
25     "tenants": [
26       {
27         "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
28         "name": "Research Dept",
29         "allocated": 20,
30         "usedMachineStats": {
31           "total": 20,
32           "initializing": 0,
33           "ready": 0,
34           "inUse": 19,
35           "error": 1,
36           "maintenance": 0,
37           "unknown": 0
38         },
39         "maxAllocatable": 2,
40         "allocations": [
41           {
42             "id": "1c6b147e-3f3a-4a1a-9f3d-2a7b8e4d5c6f",
43             "name": "AI Training Cluster",
44             "total": 15
45           }
46         ]
47       }
48     ]
49   }
50 ]

Returns machine stats for each instance type including allocation details and tenant breakdown.

User must have authorization role with PROVIDER_ADMIN suffix. The specified site must belong to the Provider.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site

Response

idstringOptionalformat: "uuid"

Unique identifier for the InstanceType

namestringOptional

Name of the InstanceType

assignedMachineStatsobjectOptional

AssignedMachineStats captures the status of all Machines assigned to this Instance Type

allocatedintegerOptional

Number of Machines of this Instance Type allocated to Tenants

maxAllocatableintegerOptional

Number of Ready Machines of this Instance Type available for additional allocation to Tenants

usedMachineStatsobjectOptional

UsedMachineStats captures the usage status of machines assigned to this instance type that are currently associated with Tenant Instances

tenantslist of objectsOptional

Per-tenant breakdown for this instance type

Errors

403

Forbidden Error