Get project

GET

http://localhost:8080/api/v1/org-unit/projects/:projectId

GET

/api/v1/org-unit/projects/:projectId

curl http://localhost:8080/api/v1/org-unit/projects/575c19e8-c7c3-45b0-8290-2f47397a8383 \
     -H "Authorization: Bearer <token>"

{
  "description": "string",
  "id": "33",
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "parentId": "53a9228e-a722-420d-a102-9dc90da2efca",
  "enforceRunaiScheduler": true,
  "status": {
    "namespace": "runai-proj1",
    "phase": "Creating",
    "phaseMessage": "Project is ready",
    "lastUpdatedTime": "2024-01-15T09:30:00Z",
    "nodePoolQuotaStatuses": [
      {
        "nodePoolName": "string",
        "nodePoolId": "string",
        "allocated": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "allocatedNonPreemptible": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "requested": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        }
      }
    ],
    "quotaStatus": {
      "allocated": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "allocatedNonPreemptible": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "requested": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      }
    },
    "additionalStatusData": {}
  },
  "totalResources": {
    "gpuQuota": 1.1,
    "cpuQuota": 1.1,
    "memoryQuota": 1.1
  },
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "effective": {
    "schedulingRules": {
      "interactiveJobTimeLimitSeconds": 100,
      "interactiveJobMaxIdleDurationSeconds": 100,
      "interactiveJobPreemptIdleDurationSeconds": 100,
      "trainingJobMaxIdleDurationSeconds": 100,
      "trainingJobTimeLimitSeconds": 100
    },
    "defaultNodePools": [
      "string"
    ],
    "nodeTypes": {
      "training": [
        "string"
      ],
      "workspace": [
        "string"
      ],
      "names": {}
    }
  },
  "resources": [
    {
      "gpu": {
        "deserved": 1000,
        "limit": 0,
        "overQuotaWeight": 2
      },
      "nodePool": {
        "id": "22",
        "name": "default"
      },
      "cpu": {
        "deserved": 1000,
        "limit": 0,
        "overQuotaWeight": 2
      },
      "memory": {
        "units": "Mib",
        "deserved": 1000,
        "limit": 0,
        "overQuotaWeight": 2
      },
      "rank": "High"
    }
  ],
  "schedulingRules": {
    "interactiveJobTimeLimitSeconds": 100,
    "interactiveJobMaxIdleDurationSeconds": 100,
    "interactiveJobPreemptIdleDurationSeconds": 100,
    "trainingJobMaxIdleDurationSeconds": 100,
    "trainingJobTimeLimitSeconds": 100
  },
  "defaultNodePools": [
    "string"
  ],
  "nodeTypes": {
    "training": [
      "string"
    ],
    "workspace": [
      "string"
    ],
    "names": {}
  },
  "requestedNamespace": "runai-proj1",
  "createdBy": "string",
  "updatedBy": "string",
  "parent": {
    "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
    "name": "organization1"
  },
  "overtimeData": {
    "range24hData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range7dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range30dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    }
  }
}

Get a project by id

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

projectIdstringRequired

The project id

Response

descriptionstring

The description of the project.

idstring

namestring

clusterIdstringformat: "uuid"

The id of the cluster.

parentIdstring

department parent uuid

enforceRunaiSchedulerboolean

a flag to enforce that all pods in this namespace will be scheduled with runai-scheduler. Supported for cluster v2.21+

statusobject

totalResourcesobject

createdAtdatetime

updatedAtdatetime

effectiveobject

resourceslist of objects

Resources assigned to this Organization per Node Pool

schedulingRulesobjectOptional

Scheduling rules that define time limits and idle GPU timeouts for workloads in this org-unit. These rules help manage resource utilization by automatically terminating or preempting idle or long-running workloads.

defaultNodePoolslist of strings or nullOptional

An ordered list of node pools that defines the default scheduling preference for workloads in this project. The Scheduler will attempt to schedule workloads on node pools in this order. This setting is enforced if no node pool list is defined in the workload policy.

nodeTypesobjectOptional

Deprecated: use a workload policy node selector to target node types instead. Node type configurations for different workload types (training, workspace). Specifies which node types are allowed for each workload type. Enforced when no node type is configured in the workload policy.

requestedNamespacestring or nullOptional

the project's namespace only if requested

createdBystringOptional

updatedBystringOptional

parentobjectOptional

Department or project parent

overtimeDataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

503

Service Unavailable Error