Update NVLink Logical Partition

PATCH

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

PATCH

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

$ curl -X PATCH https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/nvlink-logical-partition/nvLinkLogicalPartitionId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "partition-east-gpu",
>   "description": "NVLink Logical Partition for model training Instances"
> }'

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

Update a specific NVLink Logical Partition

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

nvLinkLogicalPartitionIdstringRequired

ID of the NVLink Logical Partition

Request

This endpoint expects an object.

namestring or nullOptional2-256 characters

Updated name for the NVLink Logical Partition

descriptionstring or nullOptional

Updated description for the NVLink Logical Partition

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

400

Bad Request Error

403

Forbidden Error