Get AI application. [Experimental] | NVIDIA Run:ai Documentation

{
  "id": "string",
  "name": "string",
  "source": "string",
  "type": "string",
  "desiredPhase": "string",
  "phase": "string",
  "projectId": "1",
  "projectName": "project-a",
  "departmentId": "2",
  "departmentName": "default",
  "resources": [
    {
      "id": "string",
      "name": "string",
      "kind": "string"
    }
  ],
  "allocatedResources": {
    "gpu": 1.5,
    "gpuMemory": "200Mi",
    "cpu": 0.5,
    "cpuMemory": "0B"
  },
  "requestedResources": {
    "gpu": {
      "limit": 1.5,
      "request": 1
    },
    "gpuMemory": {
      "limit": "2G",
      "request": "200M"
    },
    "cpu": {
      "limit": 1.5,
      "request": 1
    },
    "cpuMemory": {
      "limit": "2G",
      "request": "200M"
    }
  },
  "createdAt": "2024-01-15T09:30:00Z",
  "createdBy": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "updatedBy": "string",
  "updateCount": 1,
  "actionStatus": "string",
  "actionMessage": "string",
  "endpoints": [
    {
      "host": "string",
      "port": 1,
      "path": "string",
      "tlsEnabled": true,
      "protocol": "string",
      "url": "string",
      "workloadId": "string"
    }
  ],
  "resourceConnections": [
    {
      "name": "my-data-pvc",
      "kind": "PersistentVolumeClaim",
      "uid": "string",
      "workloadId": "string"
    }
  ],
  "spec": {
    "chartRef": {
      "repo": "https://charts.bitnami.com/bitnami",
      "chartName": "redis",
      "chartVersion": "17.3.17",
      "chartURL": "https://helm.ngc.nvidia.com/nvidia/blueprint/charts/nvidia-blueprint-rag-v2.3.0.tgz",
      "chartId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "values": {},
    "valuesBase64": "string",
    "auth": {
      "userCredential": true,
      "assetId": "string"
    }
  }
}

Get AI application.

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

aiApplicationIdstringRequiredformat: "uuid"

The unique identifier of the application.

Response

ok.

idstringOptionalformat: "uuid"

namestringOptionalformat: "^[a-z]([a-z0-9-]*[a-z0-9])?$"<=63 characters

The name of the application. The name must be unique within the organization and can only contain lowercase alphanumeric characters and hyphens. It must start with a letter.

sourcestringOptional

typestringOptional

desiredPhasestring or nullOptional

The desired phase of the application.

phasestringOptional

The actual status of the release in the cluster.

projectIdstringOptionalformat: ".*"

The id of the project.

projectNamestringOptionalformat: "^[a-z0-9]([a-z0-9-]*[a-z0-9])?$">=1 character

The name of the project

departmentIdstringOptionalformat: ".*">=1 character

The id of the department.

departmentNamestringOptionalformat: "^[a-z0-9]([a-z0-9-]*[a-z0-9])?$">=1 character

The name of the department

resourceslist of objectsOptional

allocatedResourcesobjectOptional

requestedResourcesobjectOptional

createdAtdatetimeOptional

createdBystringOptional>=1 character

The user who created the application.

updatedAtdatetimeOptional

updatedBystringOptional>=1 character

The user who created the application.

updateCountlongOptional

The sync update counter for this application.

actionStatusstring or nullOptional

The status of the recent action preformed on the application.

actionMessagestring or nullOptional

The message of the recent action preformed on the application.

endpointslist of objectsOptional

List of network endpoints through which the workloads associated with the AI application is exposed.

resourceConnectionslist of objectsOptional

Links between the application’s workloads and the referenced resources (PersistentVolumeClaims, Secrets, ConfigMaps). Each entry connects one workload to one resource, so a resource shared by several workloads appears once per workload.

specobject or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error