Retrieve per-tenant instance type allocation stats for a site

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "org": "acme-corp",
    "orgDisplayName": "Acme Corporation",
    "instanceTypes": [
      {
        "id": "7b9c9f1e-4d3a-4f2a-9f3b-1a2b3c4d5e6f",
        "name": "m5.large",
        "allocated": 25,
        "usedMachineStats": {
          "total": 30,
          "initializing": 2,
          "ready": 5,
          "inUse": 18,
          "error": 1,
          "maintenance": 3,
          "unknown": 1
        },
        "maxAllocatable": 50,
        "allocations": [
          {
            "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "name": "web-servers",
            "total": 15
          }
        ]
      }
    ]
  }
]

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

User must have FORGE_PROVIDER_ADMIN authorization role. 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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

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

Errors

403

Forbidden Error