v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
NVLink Logical Partition

Retrieve NVLink Logical Partition

Retrieve a specific NVLink Logical Partition by ID

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

get/v2/org/{org}/nico/nvlink-logical-partition/{nvLinkLogicalPartitionId}

Query parameters

includeInterfacesstring

Include all attached NVLink Interfaces in response

includeStatsboolean

Include NVLink Logical Partition Stats in response

includeVpcsboolean

Include all attached VPCs in response

includeRelation'Site' | 'Tenant'

Related entity to expand

Response

OK

idstring uuid

Unique ID of the NVLink Logical Partition

namestring

Name of the NVLink Logical Partition

descriptionstring nullable

Optional description of the NVLink Logical Partition

siteIdstring uuid

ID of the Site the NVLink Logical Partition belongs to

tenantIdstring uuid

ID of the Tenant the NVLink Logical Partition belongs to

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

Status values for NVLink Logical Partition objects

createdstring date-time

Date and time the NVLink Logical Partition was created

updatedstring date-time

Date and time the NVLink Logical Partition was last updated

Example response

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