Retrieve InfiniBand Partition

GET

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

GET

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

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

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

Retrieve a specific InfiniBand Partition

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

Tenant must own the Partition.

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

infiniBandPartitionIdstringRequired

ID of the InfiniBand Partition

Query parameters

includeRelationenumOptional

Related entity to expand

Allowed values:

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