get a Storage Class/Classes for a given cluster

GET

http://localhost:8080/api/v2/storage-classes

GET

/api/v2/storage-classes

curl -G http://localhost:8080/api/v2/storage-classes \
     -H "Authorization: Bearer <token>" \
     -d clusterId=d73a738f-fab3-430a-8fa3-5241493d7128

{
  "items": [
    {
      "clusterId": "550e8400-e29b-41d4-a716-446655440000",
      "storageClassName": "my-storage-class",
      "spec": {
        "isDefault": false,
        "provisioner": "kubernetes.io/aws-ebs",
        "allowVolumeExpansion": true
      },
      "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"
          }
        ]
      }
    }
  ]
}

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

clusterIdstringRequiredformat: "uuid"

The id of the cluster

namestringOptional

filter by name

includeNonebooleanOptional

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

Response

Executed successfully.

itemslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

503

Service Unavailable Error