Retrieve per-tenant instance type allocation stats for a site

GET

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

GET

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

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

1 [
2   {
3     "id": "d4f5a8b2-9c3e-4f7a-8b1d-2e3f4a5c6d7e",
4     "org": "acme-corp",
5     "orgDisplayName": "Acme Corporation",
6     "instanceTypes": [
7       {
8         "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
9         "name": "gpu-standard-8",
10         "allocated": 24,
11         "usedMachineStats": {
12           "total": 24,
13           "initializing": 2,
14           "ready": 10,
15           "inUse": 10,
16           "error": 1,
17           "maintenance": 0,
18           "unknown": 1
19         },
20         "maxAllocatable": 50,
21         "allocations": [
22           {
23             "id": "f1234567-89ab-4cde-f012-3456789abcde",
24             "name": "project-alpha",
25             "total": 14
26           },
27           {
28             "id": "a9876543-21bc-4def-8901-23456789abcd",
29             "name": "project-beta",
30             "total": 10
31           }
32         ]
33       }
34     ]
35   }
36 ]

Returns instance type allocation stats grouped by tenant for the specified site.

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

idstringformat: "uuid"

Unique identifier for the Tenant

orgstring

Organization name for the Tenant

orgDisplayNamestring

Display name for the Tenant's organization

instanceTypeslist of objects

Instance Type statistics for this Tenant

Errors

403

Forbidden Error