Instance

Retrieve all Instance NVLink Interfaces

Changed on

Get all NVLink Interfaces for an Instance

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

get/v2/org/{org}/nico/instance/{instanceId}/nvlink-interface

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/instance/{instanceId}/nvlink-interface
  • Auth
    HTTP bearer

Query parameters

statusstring

Filter NVLink Interfaces by Status. Can be specified multiple times to filter on more than one status.

includeRelation'Instance' | 'NVLinkLogicalPartition'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique UUID v4 identifier for the NVLinkInterface

instanceIdstring uuid

ID of the associated Instance

nvLinkLogicalPartitionIdstring uuid

ID of the NVLink Logical Partition associated with this interface

nvLinkDomainIdstring uuid nullable

Core-reported NVLink domain UUID associated with this Interface, not the rack group ID returned by the Domain API.

deviceInstanceinteger

Index of the device, used to identify the GPU associated with this Interface

gpuGuidstring nullable

Unique ID of the GPU

status'Pending' | 'Provisioning' | 'Ready' | 'Deleting' | 'Error'

Status values for NVLink Interface objects

createdstring date-time

Date/time when the NVLinkInterface was created

updatedstring date-time

Date/time when the NVLinkInterface was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
    "nvLinkLogicalPartitionId": "05ef7e84-1d4e-4e4d-980d-38589479a0fe",
    "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
    "deviceInstance": 0,
    "gpuGuid": "4fe82bc6-1e30-4dfd-8839-996596209883",
    "status": "Ready",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes