Retrieve all Instance NVLink Interfaces

curl https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/instance/instanceId/nvlink-interface \
     -H "Authorization: Bearer <token>"

[
  {
    "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 FORGE_TENANT_ADMIN authorization role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

instanceIdstringRequired

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:

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringformat: "uuid">=1 character

instanceIdstringformat: "uuid"

nvLinkLogicalPartitionIdstringformat: "uuid"

ID of the NVLink Logical Partition associated with this interface

nvLinkDomainIdstringformat: "uuid"

ID of the NVLink Domain associated with this Interface

deviceInstanceinteger

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

gpuGuidstring

Unique ID of the GPU

statusenum

Status values for NVLink Interface objects

Allowed values:

createddatetimeRead-only

updateddatetimeRead-only

Errors

403

Forbidden Error