Storage Classes

Deprecated

Get all storageClasses from a cluster.

get

this API is used by cluster versions < 2.20

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

uuidstring · uuidRequired

Unique identifier of the cluster

Query parameters

includeNonebooleanOptional

Include runai-none storage class to be able to create PVCs without a storage class

Responses

200

Expected response to a valid request

application/json

storageClassesstring[]OptionalExample: ["standard"]

401

Unauthorized

application/json

404

The specified resource was not found

application/json

default

unexpected error

application/json

get/v1/k8s/clusters/{uuid}/storage-classes

GET /v1/k8s/clusters/{uuid}/storage-classes HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "storageClasses": [
    "standard"
  ]
}

get a Storage Class/Classes for a given cluster

get

Authorizations

AuthorizationstringRequired

Bearer authentication

Query parameters

clusterIdstring · uuidRequired

The id of the cluster

Example: d73a738f-fab3-430a-8fa3-5241493d7128

namestringOptional

filter by name

includeNonebooleanOptional

Include runai-none storage class, which is used for static provisioning of PVC. In static provisioning storage is omitted.

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get/api/v1/storage-classes

GET /api/v1/storage-classes?clusterId=d73a738f-fab3-430a-8fa3-5241493d7128 HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "cluster_id": "550e8400-e29b-41d4-a716-446655440000",
      "storage_class_name": "my-storage-class",
      "Spec": {
        "provisioner": "kubernetes.io/aws-ebs",
        "allow_volume_expansion": true,
        "is_default": false
      }
    }
  ]
}

get a Storage Class/Classes for a given cluster

get

Authorizations

AuthorizationstringRequired

Bearer authentication

Query parameters

clusterIdstring · uuidRequired

The id of the cluster

Example: d73a738f-fab3-430a-8fa3-5241493d7128

namestringOptional

filter by name

includeNonebooleanOptional

Include runai-none storage class, which is used for static provisioning of PVC. In static provisioning storage is omitted.

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get/api/v2/storage-classes

GET /api/v2/storage-classes?clusterId=d73a738f-fab3-430a-8fa3-5241493d7128 HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "clusterId": "550e8400-e29b-41d4-a716-446655440000",
      "storageClassName": "my-storage-class",
      "spec": {
        "provisioner": "kubernetes.io/aws-ebs",
        "allowVolumeExpansion": true,
        "isDefault": false
      },
      "permissions": {
        "allowedForAssets": true,
        "allowedForWorkloads": true,
        "allowedForEphemeralVolumes": true,
        "allowedForPersistentVolumes": true,
        "allowDataSharing": true
      },
      "customization": {
        "accessMode": {
          "required": true,
          "default": {
            "readWriteOnce": true,
            "readOnlyMany": false,
            "readWriteMany": false
          },
          "supportedValues": {
            "readWriteOnce": true,
            "readOnlyMany": true,
            "readWriteMany": true
          }
        },
        "volumeMode": {
          "required": true,
          "default": "Filesystem",
          "supportedValues": {
            "filesystem": true,
            "block": true
          }
        },
        "claimSize": {
          "default": "1G",
          "supportedUnits": [
            "MB"
          ],
          "min": "1G",
          "max": "1G",
          "step": "1G"
        },
        "attributes": [
          {
            "key": "dnsname",
            "format": "text",
            "display": "DNS Name",
            "description": "The host name of the DNS",
            "placeholder": "enter hostname or IP address",
            "required": "true",
            "defaultValue": "my.dns.com",
            "validationRegexp": "^[a-zA-Z0-9.-_]+$",
            "minValue": "100",
            "maxValue": "200",
            "step": "5",
            "validationError": "Invalid URL"
          }
        ]
      }
    }
  ]
}