Allocation

Create Allocation

Changed on

Create an Allocation for the org.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

To successfully create a compute Allocation, there must be enough unallocated Machines associated with the Instance Type to satisfy the constraint value. For network Allocation, the source site-level IP Block must have an available prefix with length equal to the constraint value. When that IP Block is linked to an OperatorManaged SitePrefix, it must also be Ready. A conflict involving capacity, address space, or lifecycle state returns 409.

post/v2/org/{org}/nico/allocation

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/allocation
  • Auth
    HTTP bearer

Request body

namestring required

Concise and descriptive name for the Allocation

descriptionstring nullable

Detailed description for the Allocation

tenantIdstring uuid required

ID of the Tenant that should receive the Allocation

siteIdstring uuid required

ID of the Site where resources should be allocated

Example request

{
  "name": "Echo Studios",
  "description": "Echo Studios resource allocation in SJC4",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "allocationConstraints": [
    {
      "resourceType": "InstanceType",
      "resourceTypeId": "bd5a0240-eb62-4bff-91f7-335e6bb86459",
      "constraintType": "Reserved",
      "constraintValue": 10
    }
  ]
}

Response

Created

idstring uuid

ID of the Allocation

namestring

Concise and descriptive name of the Allocation

descriptionstring nullable

Detailed description of the Allocation

infrastructureProviderIdstring uuid

ID of the Infrastructure Provider that created the Allocation

tenantIdstring uuid

ID of the Tenant that received the Allocation

siteIdstring uuid

ID of the Site where resources are allocated

status'Pending' | 'Registered' | 'Deleting' | 'Error'

Status values for Allocation objects

createdstring date-time

Date/time when the Allocation was created

updatedstring date-time

Date/time when the Allocation was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Echo Studios Allocations",
  "description": "Echo Studios resource allocation in SJC4",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "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",
  "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,
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ]
}

Changes

  • db15b7308121Revision changes
    • info

      added the optional property /// to the response with the status

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status