List compute assets.

GET

http://localhost:8080/api/v1/asset/compute

GET

/api/v1/asset/compute

curl http://localhost:8080/api/v1/asset/compute \
     -H "Authorization: Bearer <token>"

{
  "entries": [
    {
      "meta": {
        "name": "my-asset",
        "scope": "tenant",
        "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
        "kind": "s3",
        "createdBy": "test@run.ai",
        "createdAt": "2023-02-23T14:25:36.707685Z",
        "updatedBy": "test@run.ai",
        "updatedAt": "2023-02-23T14:25:36.707685Z",
        "workloadSupportedTypes": {
          "workspace": false,
          "training": false,
          "distributed": true,
          "distFramework": "TF"
        }
      },
      "spec": {
        "cpuCoreLimit": 2,
        "cpuCoreRequest": 0.5,
        "cpuMemoryLimit": "30M",
        "cpuMemoryRequest": "20M",
        "extendedResources": [
          {
            "resource": "hardware-vendor.example/foo",
            "quantity": "2",
            "exclude": false
          }
        ],
        "gpuDevicesRequest": 1,
        "gpuMemoryLimit": "10M",
        "gpuMemoryRequest": "10M",
        "gpuPortionLimit": 0.5,
        "gpuPortionRequest": 0.5,
        "gpuRequestType": "portion",
        "largeShmRequest": false
      },
      "usedBy": {
        "workspaces": [
          {
            "id": "string",
            "name": "my-workload-name",
            "status": "string"
          }
        ],
        "trainings": [
          {
            "id": "string",
            "name": "my-workload-name",
            "status": "string"
          }
        ],
        "distributed": [
          {
            "id": "string",
            "name": "my-workload-name",
            "status": "string"
          }
        ],
        "inferences": [
          {
            "id": "string",
            "name": "my-workload-name",
            "status": "string"
          }
        ],
        "templates": [
          {
            "id": "string",
            "name": "my-asset"
          }
        ],
        "assets": {
          "environment": {
            "id": "string",
            "name": "my-asset",
            "toolTypes": [
              "jupyter-notebook"
            ]
          },
          "environments": [
            {
              "id": "string",
              "name": "my-asset"
            }
          ],
          "compute": {
            "id": "string",
            "name": "my-asset"
          },
          "computes": [
            {
              "id": "string",
              "name": "my-asset"
            }
          ],
          "datasources": [
            {
              "id": "string",
              "name": "my-asset",
              "kind": "compute",
              "overrides": {
                "containerPath": "/container/directory"
              }
            }
          ]
        }
      },
      "usageTimes": {
        "lastUsedByWorkload": "2024-01-15T09:30:00Z"
      },
      "compliance": {
        "imposed": true,
        "compliance": true,
        "reason": [
          {
            "details": "string",
            "field": "string",
            "rule": "min"
          }
        ]
      }
    }
  ]
}

Use to retrieve a list of compute assets.

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

namestringOptional

Filter results by name.

scopestringOptional

Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project.

projectIdintegerOptional

Filter results by project id. If scope filter is project, only assets from the specific project will be included in the response. Otherwise, the response will include project, department, cluster, tenant and system assets.

departmentIdstringOptional

Filter results by department id. If scope filter is department, only assets from the specific department will be included in the response. Otherwise, the response will include department, cluster, tenant and system assets.

clusterIdstringOptionalformat: "uuid"

Filter results by Universally Unique Identifier (UUID) of the cluster. If scope filter is cluster, only assets from the specific cluster will be included in the response. Otherwise, the response will include cluster, tenant and system assets.

usageInfobooleanOptional

Whether the query should include asset usage information as part of the response.

complyToProjectintegerOptional

Include workload creation compliance information of an asset, for a given project, as part of the response. To check compliance, you need to provide both project id and workload type.

complyToWorkloadTypeenumOptional

Include workload creation compliance information of an asset, for a given workload type, as part of the response. To check compliance, you need to provide both project id and workload type.

Allowed values:

complyToReplicaTypeenumOptional

Include workload creation compliance information of an asset, for a given replica type, as part of the response. To check compliance, you need to provide both project id and workload type. For distributed, replica type should be provided as well.

Allowed values:

includeDescendantsbooleanOptional

Indicates whether to include assets from all descendant scopes under the specified scope. When set to true, and a specific scope identifier (for example, clusterId) is provided, the query also returns assets from all nested scopes within it (for example, departments and projects). Mutually exclusive with scope.

Response

Request completed successfully.

entrieslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error