List access keys. | NVIDIA Run:ai Documentation

{
  "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": {
        "keyId": 1,
        "existingSecretName": "string",
        "accessKeyId": "string",
        "secretAccessKey": "string"
      },
      "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"
              }
            }
          ]
        }
      },
      "compliance": {
        "imposed": true,
        "compliance": true,
        "reason": [
          {
            "details": "string",
            "field": "string",
            "rule": "min"
          }
        ]
      },
      "status": {
        "status": "Creating",
        "issues": [
          {
            "scopeId": "string",
            "scopeType": "system",
            "issue": "ReplicationError"
          }
        ],
        "message": "string",
        "url": "string"
      },
      "clusterInfo": {
        "resources": [
          {
            "name": "password-credential-1"
          }
        ]
      }
    }
  ]
}

Use to retrieve a list of S3-compatible access key credentials.

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.

statusInfobooleanOptional

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

Response

Request completed successfully.

entrieslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error