Get projects

GET

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

GET

/api/v1/org-unit/projects

curl http://localhost:8080/api/v1/org-unit/projects \
     -H "Authorization: Bearer <token>"

{
  "projects": [
    {
      "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"
        }
      }
    }
  ],
  "next": 1
}

List projects

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

filterBylist of stringsOptional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

sortByenumOptional

Sort results by a parameters.

sortOrderenumOptionalDefaults to asc

Sort results in descending or ascending order.

Allowed values:

offsetintegerOptional

The offset of the first item returned in the collection.

limitintegerOptional1-500Defaults to 50

The maximum number of entries to return.

searchstringOptional

Filter results by a free text search.

Response

projectslist of objects

nextintegerOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error