Retrieve all Instance NVLink Interfaces

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/instance/:instanceId/nvlink-interface

GET

/v2/org/:org/nico/instance/:instanceId/nvlink-interface

curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/instance/instanceId/nvlink-interface \
     -H "Authorization: Bearer <token>" \
     -d pageSize=20

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
    "nvLinkLogicalPartitionId": "05ef7e84-1d4e-4e4d-980d-38589479a0fe",
    "nvLinkDomainId": "4b145552-0d8f-45ff-b652-eed105f93e50",
    "deviceInstance": 0,
    "gpuGuid": "5108732638879268442",
    "status": "Ready",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  },
  {
    "id": "8a7c3b21-1ffc-4c78-9a00-2a6f3859d099",
    "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
    "nvLinkLogicalPartitionId": "05ef7e84-1d4e-4e4d-980d-38589479a0fe",
    "nvLinkDomainId": "4b145552-0d8f-45ff-b652-eed105f93e50",
    "deviceInstance": 1,
    "gpuGuid": "5108732638879268443",
    "status": "Provisioning",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Get all NVLink Interfaces for an Instance

Org must have a Tenant entity. User must have authorization role with TENANT_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

instanceIdstringRequired

ID of the Instance

Query parameters

statusstringOptional

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

includeRelationenumOptional

Related entity to expand

Allowed values:

pageNumberintegerOptional1-21474836

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringOptionalformat: "uuid">=1 character

Unique UUID v4 identifier for the NVLinkInterface

instanceIdstringOptionalformat: "uuid"

ID of the associated Instance

nvLinkLogicalPartitionIdstringOptionalformat: "uuid"

ID of the NVLink Logical Partition associated with this interface

nvLinkDomainIdstring or nullOptionalformat: "uuid"

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

deviceInstanceintegerOptional

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

gpuGuidstring or nullOptional

Unique ID of the GPU

statusenumOptional

Status of the NVLinkInterface

Allowed values:

createddatetimeOptionalRead-only

Date/time when the NVLinkInterface was created

updateddatetimeOptionalRead-only

Date/time when the NVLinkInterface was last updated

deprecationslist of objectsOptional

Deprecations active for this resource. Returned only if there are active deprecations.

Errors

403

Forbidden Error