Retrieve all InfiniBand Partitions

GET

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

GET

/v2/org/:org/nico/infiniband-partition

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

1 [
2   {
3     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
4     "name": "turbo-net",
5     "description": "InfiniBand Partition for model training Instances",
6     "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
7     "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
8     "controllerIBPartitionId": "0e60d064-3d38-4812-84d9-c3353bd96eaf",
9     "partitionKey": "0x1",
10     "partitionName": "turbo-net",
11     "serviceLevel": 5,
12     "rateLimit": 40,
13     "mtu": 4000,
14     "enableSharp": true,
15     "labels": {
16       "environment": "production",
17       "team": "devops"
18     },
19     "status": "Pending",
20     "statusHistory": [
21       {
22         "status": "Pending",
23         "message": "Request received, pending processing",
24         "created": "2019-08-24T14:15:22Z",
25         "updated": "2019-08-24T14:15:22Z"
26       }
27     ],
28     "created": "2019-08-24T14:15:22Z",
29     "updated": "2019-08-24T14:15:22Z"
30   }
31 ]

Retrieve all InfiniBand 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 Org

Query parameters

siteIdstringOptionalformat: "uuid"

Filter Partitions by Site

statusstringOptional

Filter Partitions by Status

querystringOptional

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

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 UUID v4 identifier for the InfiniBand Partition

namestring2-256 characters

Name of the InfiniBand Partition

descriptionstring or null

Description of the InfiniBand Partition

siteIdstringformat: "uuid"

ID of the Site

tenantIdstringformat: "uuid"

ID of the Tenant

controllerIBPartitionIdstring or nullformat: "uuid"

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

partitionKeystring or nullRead-only

Partition key assigned to the InfiniBand Partition

partitionNamestring or nullRead-only

Partition name assigned to the InfiniBand Partition

serviceLevelinteger or nullRead-only0-15

Service level configured for the InfiniBand Partition

rateLimitenumRead-only

Rate limit configured for the InfiniBand Partition

mtuenumRead-only

MTU configured for the InfiniBand Partition

enableSharpbooleanRead-only

Whether SHARP is enabled for the InfiniBand Partition

labelsmap from strings to strings

String key-value pairs describing InfiniBand Partition labels. Up to 10 key-value pairs can be specified

statusenum

Status of the InfiniBand Partition

statusHistorylist of objectsRead-only

Chronological status history for the InfiniBand Partition

createddatetimeRead-only

Date/time when the InfiniBand Partition was created

updateddatetimeRead-only

Date/time when the InfiniBand Partition was last updated

Errors

403

Forbidden Error