Retrieve all NVLink Logical Partitions

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/nvlink-logical-partition

GET

/v2/org/:org/nico/nvlink-logical-partition

$ curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/nvlink-logical-partition \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "id": "ded96bdf-905e-40dd-8a58-3472aab60042",
4     "name": "partition-east-gpu",
5     "description": "NVLink Logical Partition for model training Instances",
6     "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
7     "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
8     "status": "Pending",
9     "statusHistory": [
10       {
11         "status": "Pending",
12         "message": "Request received, pending processing",
13         "created": "2019-08-24T14:15:22Z",
14         "updated": "2019-08-24T14:15:22Z"
15       }
16     ],
17     "created": "2019-08-24T14:15:22Z",
18     "updated": "2019-08-24T14:15:22Z"
19   }
20 ]

Retrieve all NVLink Logical Partitions for the org

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

``` 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 NGC Org

Query parameters

siteIdstringOptionalformat: "uuid"

Filter NVLink Logical Partitions by Site

statusstringOptional

Filter NVLink Logical Partitions by Status

querystringOptional

Search for matches across all NVLink Logical Partitions. Input will be matched against name, description, and status fields

includeInterfacesbooleanOptional

Include NVLink Interfaces in response.

includeStatsbooleanOptional

Include NVLink Logical Partition Stats in response.

includeVpcsbooleanOptional

Include VPCs in response.

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

idstringRead-onlyformat: "uuid"

Unique ID of the NVLink Logical Partition

namestring2-256 characters

Name of the NVLink Logical Partition

descriptionstring or null

Optional description of the NVLink Logical Partition

siteIdstringformat: "uuid"

ID of the Site the NVLink Logical Partition belongs to

tenantIdstringformat: "uuid"

ID of the Tenant the NVLink Logical Partition belongs to

statusenum

Status of the NVLink Logical Partition

statusHistorylist of objectsRead-only

Details of status changes for the NVLink Logical Partition over time

nvLinkLogicalPartitionStatsobject

GPU and Instance usage counts for the NVLink Logical Partition. Returned if the includeStats query parameter is set to true in retrieval endpoints

createddatetimeRead-only

Date and time the NVLink Logical Partition was created

updateddatetimeRead-only

Date and time the NVLink Logical Partition was last updated

Errors

403

Forbidden Error