Retrieve Allocation | NVIDIA Infra Controller

curl https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/allocation/allocationId \
     -H "Authorization: Bearer <token>"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Echo Studios",
  "description": "Echo Studios resource allocation in SJC4",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "status": "Pending",
  "statusHistory": [
    {
      "status": "Pending",
      "message": "Request received, pending processing",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "allocationConstraints": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "allocationId": "9ec871ce-3363-4de2-8f79-062881067628",
      "resourceType": "InstanceType",
      "resourceTypeId": "a59ee688-b5e5-4606-9891-f4a605edacd3",
      "constraintType": "Reserved",
      "constraintValue": 10,
      "derivedResourceId": null,
      "instanceType": {
        "name": "x3.large",
        "infrastructureProviderId": "63c29416-8833-4eaf-9e1c-7c0173cc3150",
        "siteId": "c9f4f276-6f7a-4209-953c-2b9870ce7cc1",
        "status": "Ready"
      },
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Retrieve Allocation by ID

Provider and Tenant roles are inferred from the org’s membership. Allocation must belong to the Provider or Tenant associated with the org.

User must have FORGE_PROVIDER_ADMIN or FORGE_TENANT_ADMIN role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

allocationIdstringRequired

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"Deprecated

Filter Allocations by Infrastructure Provider ID.

tenantIdstringOptionalformat: "uuid"Deprecated

Filter Allocations by Tenant ID.

includeRelationenumOptional

Related entity to expand

Allowed values:

Response

idstringRead-onlyformat: "uuid"

ID of the Allocation

namestring2-256 characters

Concise and descriptive name of the Allocation

descriptionstring

Detailed description of the Allocation

infrastructureProviderIdstringformat: "uuid"

ID of the Infrastructure Provider that created the Allocation

tenantIdstringformat: "uuid"

ID of the Tenant that received the Allocation

siteIdstringformat: "uuid"

ID of the Site where resources are allocated

statusenum

Status values for Allocation objects

Allowed values:

statusHistorylist of objectsRead-only

allocationConstraintslist of objects

createddatetimeRead-only

Date/time when the Allocation was created

updateddatetimeRead-only

Date/time when the Allocation was last updated

Errors

403

Forbidden Error