Sign in

v57

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

Retrieve all InfiniBand Partitions

Retrieve all InfiniBand Partitions for the org

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

get/v2/org/{org}/nico/infiniband-partition

Query parameters

siteIdstring uuid

Filter Partitions by Site

statusstring

Filter Partitions by Status

querystring

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

includeRelation'Site' | 'VPC' | 'Tenant'

Related entity to expand

pageNumberinteger
Example:1

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique UUID v4 identifier for the InfiniBand Partition

namestring

Name of the InfiniBand Partition

descriptionstring nullable

Description of the InfiniBand Partition

siteIdstring uuid

ID of the Site

tenantIdstring uuid

ID of the Tenant

controllerIBPartitionIdstring uuid nullable

ID of the Site Controller InfiniBand partition corresponding to this InfiniBand Partition

partitionKeystring nullable

Partition key assigned to the InfiniBand Partition

partitionNamestring nullable

Partition name assigned to the InfiniBand Partition

serviceLevelinteger nullable

Service level configured for the InfiniBand Partition

rateLimit2 | 5 | 10 | 14 | 20 | 25 | 30 | 40 | 56 | 60 | 80 | 100 | 112 | 120 | 168 | 200 | 300 nullable

Rate limit configured for the InfiniBand Partition

mtu4000 | 8000 nullable

MTU configured for the InfiniBand Partition

enableSharpboolean

Whether SHARP is enabled for the InfiniBand Partition

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

Status values for InfiniBand Partition objects

createdstring date-time

Date/time when the InfiniBand Partition was created

updatedstring date-time

Date/time when the InfiniBand Partition was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "turbo-net",
    "description": "InfiniBand Partition for model training Instances",
    "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "controllerIBPartitionId": "0e60d064-3d38-4812-84d9-c3353bd96eaf",
    "partitionKey": "0x1",
    "partitionName": "turbo-net",
    "serviceLevel": 5,
    "rateLimit": 40,
    "mtu": 4000,
    "enableSharp": true,
    "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"
  }
]