Expected Rack

Retrieve all Expected Racks

Changed on

Retrieve all Expected Racks.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Racks if they have an account with the Site's Infrastructure Provider (siteId query parameter is required for Tenants).

get/v2/org/{org}/nico/expected-rack

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/expected-rack
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid

ID of the Site to filter Expected Racks by

includeRelation'Site'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'RACK_ID_ASC' | 'RACK_ID_DESC' | 'RACK_PROFILE_ID_ASC' | 'RACK_PROFILE_ID_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique identifier (UUID) for the Expected Rack

rackIdstring

Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

siteIdstring uuid

ID of the Site the Expected Rack belongs to

rackProfileIdstring

Identifier of the Rack Profile this rack conforms to

rackGroupIdstring nullable

External rack group ID selected and persisted at creation together with rackProfileId. Null for legacy rows without a recorded group; metadata updates preserve it.

namestring

Human-readable name of the Expected Rack

descriptionstring

Human-readable description of the Expected Rack

labelsLabels

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

createdstring date-time

ISO 8601 datetime when the Expected Rack was created

updatedstring date-time

ISO 8601 datetime when the Expected Rack was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "rackId": "rack-01",
    "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "rackProfileId": "rp-standard-42u",
    "name": "Rack 01",
    "description": "Production rack in row A",
    "labels": {
      "chassis.manufacturer": "NVIDIA",
      "chassis.serial-number": "NVRK0001001",
      "chassis.model": "GB200-NVL72",
      "location.region": "us-west-2",
      "location.datacenter": "phx-dc01",
      "location.room": "room-1",
      "location.position": "A1"
    },
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 0b2823e8f92bRevision changes
    • info

      added the optional property / to the response with the status