Get cluster storage details

Get cluster storage details

Get the storage details of the cluster.

GET/v1/clusters/{clusterId}/storages/{storageName}

Path parameters

clusterId*string

storagesName*string

Response

200

OK

Body

*/*

annotationsobject

baseStorageYnstring

Default storage availability (Y: Allowed, N: Not allowed)

Example: "Y"

descriptionstring

Example: ""

labesobject

mountOptionsarray of string

Mount options list

namestring

Storage name

Example: "nfs-csi"

parametersarray of object

Parameter list

phasestring

Volume status(Only used in Static Volume)(UNKNOWN, AVAILABLE, BOUND, RELEASED, FAILED, DELETED)

Example: "AVAILABLE"

pluginstring

Example: "NFS_CSI"

provisionerNamestring

Example: "nfs.csi.k8s.io"

readOnlyManyYnstring

Volume request ReadOnlyMany support availability (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteManyYnstring

Volume request ReadWriteMany support availability (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteOnceYnstring

Volume request readWriteOnceYn support availability (Y: Allowed, N: Not allowed)

Example: "Y"

reclaimPolicystring

reclaimPolicy(RECYCLE, RETAIN, DELETE, RECYCLE, RETAIN, DELETE)

Example: "RETAIN"

storageClassStorageClass (object)

storageTypestring

storageType(BLOCK, NETWORK, BLOCK, NETWORK)

Example: "NETWORK"

totalCapacityinteger

Example: 1024

typestring

Configuration type(None, HOST_PATH, EMPTY_DIR, CONFIG_MAP, SECRET, PERSISTENT_VOLUME_STATIC, PERSISTENT_VOLUME_LINKED, PERSISTENT_VOLUME)

Example: "PERSISTENT_VOLUME"

volumeBindingModestring

volumeBindingMode(IMMEDIATE, WAIT_FOR_FIRST_CONSUMER, IMMEDIATE, WAIT_FOR_FIRST_CONSUMER)

Example: "IMMEDIATE"

Request

JavaScriptCurlPython

const response = await fetch('/v1/clusters/{clusterId}/storages/{storageName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "annotations": {
    "cocktail-user-description": "bmZzLWNzaQ==",
    "meta.helm.sh/release-name": "default-storage",
    "meta.helm.sh/release-namespace": "kube-system"
  },
  "baseStorageYn": "Y",
  "description": "",
  "labes": {
    "acornsoft.io/provisioner-type": "NFS_CSI",
    "acornsoft.io/total-capacity": "1024",
    "acornsoft.io/type": "NETWORK"
  },
  "mountOptions": [
    "hard",
    "nfsvers=4.1"
  ],
  "name": "nfs-csi",
  "parameters": [
    {
      "name": "server",
      "value": "0.0.0.0"
    }
  ],
  "phase": "AVAILABLE",
  "plugin": "NFS_CSI",
  "provisionerName": "nfs.csi.k8s.io",
  "readOnlyManyYn": "Y",
  "readWriteManyYn": "Y",
  "readWriteOnceYn": "Y",
  "reclaimPolicy": "RETAIN",
  "storageClass": {
    "creationTimestamp": "2022-12-02 02:16:03",
    "deployment": "{\"apiVersion\":\"storage.k8s.io/v1\",\"kind\":\"StorageClass\"...",
    "deploymentYaml": "apiVersion: storage.k8s.io/v1\nkind: StorageClass\n...",
    "detail": {
      "annotations": {
        "cocktail-user-description": "bmZzLWNzaQ==",
        "meta.helm.sh/release-name": "default-storage",
        "meta.helm.sh/release-namespace": "kube-system"
      },
      "creationTime": "2022-12-02 02:16:03",
      "labels": {
        "acornsoft.io/provisioner-type": "NFS_CSI",
        "acornsoft.io/total-capacity": "1024",
        "acornsoft.io/type": "NETWORK"
      },
      "mountOptions": [
        "hard",
        "nfsvers=4.1"
      ],
      "name": "nfs-csi",
      "parameters": {
        "server": "0.0.0.0",
        "share": "/thingcluster"
      },
      "provisioner": "nfs.csi.k8s.io",
      "reclaimPolicy": "Retain",
      "volumeBindingMode": "Immediate"
    },
    "labes": {
      "acornsoft.io/provisioner-type": "NFS_CSI",
      "acornsoft.io/total-capacity": "1024",
      "acornsoft.io/type": "NETWORK"
    },
    "name": "nfs-csi",
    "parameters": [
      {
        "name": "server",
        "value": "0.0.0.0"
      }
    ],
    "provisioner": "nfs.csi.k8s.io"
  },
  "storageType": "NETWORK",
  "totalCapacity": 1024,
  "type": "PERSISTENT_VOLUME",
  "volumeBindingMode": "IMMEDIATE"
}