Retrieve a Tray

GET

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

Get a Tray by component ID or component MAC address.

The identifier must resolve to exactly one component. An ambiguous component ID returns 412 Precondition Failed; use the component MAC address to disambiguate it.

Org must have an Infrastructure Provider entity. 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

``` 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 or component MAC address

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site

Response

nvLinkDomainIdstring or nullformat: "uuid"

ID of the NVLink Domain containing this Tray's Rack. Null when the Rack is not assigned to an NVLink Domain.

taskStatsobject

Counts of non-terminal tasks currently associated with a rack or tray. Rack stats include component-scoped tasks on the rack; tray stats include only tasks that explicitly target the tray.

idstringOptional

Component ID

typeenumOptional

Type of the tray

namestringOptional

Name of the tray

manufacturerstringOptional

Manufacturer of the tray

modelstringOptional

Model of the tray

serialNumberstringOptional

Serial number of the tray

descriptionstringOptional

Description of the tray

firmwareVersionstringOptional

Firmware version of the tray

powerStatestringOptional

Current power state of the tray

operationStatusenumOptional

Flow-derived operability phase of the tray

leakStatusenumOptional

Whether the tray is considered leaking coolant

positionobjectOptional

Position of the Tray within the Rack

bmcslist of objectsOptional

BMC (Baseboard Management Controller) entries for the tray

rackIdstringOptional

ID of the Rack this Tray belongs to

Errors

403

Forbidden Error

404

Not Found Error

412

Precondition Failed Error

504

Gateway Timeout Error