Retrieve all Tray health reports

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/tray/:id/health-report

GET

/v2/org/:org/nico/tray/:id/health-report

curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/tray/id/health-report \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d siteId=siteId \
     -d type=Compute

[
  {
    "source": "maintenance.dpu-reprovision",
    "mode": "Merge",
    "triggeredBy": "operator",
    "observedAt": "2024-01-15T09:30:00Z",
    "successes": [
      {
        "id": "FanSpeed",
        "target": "System Board Fan1A"
      }
    ],
    "alerts": [
      {
        "id": "HostUpdateInProgress",
        "message": "DPU reprovisioning in progress",
        "target": "DPU Module 3",
        "inAlertSince": "2024-01-15T08:45:00Z",
        "tenantMessage": "Scheduled maintenance ongoing",
        "classifications": [
          "PreventAllocations"
        ]
      }
    ]
  }
]

Get all health report overrides for a specific Tray. Compute targets the Machine health report, NVSwitch targets the Switch health report, and PowerShelf targets the Power Shelf health report. If the Tray ID uses a recognized component namespace that conflicts with type, the request returns 400. If a valid ID in the selected namespace does not identify an existing resource, the request returns 404.

Org must have an Infrastructure Provider entity that owns the Site. User must have authorization role with PROVIDER_ADMIN suffix.

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

Path parameters

orgstringRequired

Name of the Org

idstringRequired

Component ID of the Tray

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site that owns the Tray

typeenumRequired

Tray type used to select the corresponding component health-report resource

Allowed values:

Response

sourcestring

Health report source.

modeenum

How this health report was updated

Allowed values:

triggeredBystringOptional

Person or system that triggered this health report.

observedAtdatetimeOptional

Date/time when the health report was observed.

successeslist of objectsOptional

Results from successful health probes for the Machine.

alertslist of objectsOptional

Results from failed health probes for the Machine.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

504

Gateway Timeout Error