Get cluster namespace PVC details

Get cluster namespace PVC details

Get detailed information for PVC in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/persistentvolumeclaims/{pvcName}

Path parameters

clusterId*string

namespaceName*string

pvcName*string

Response

200

OK

Body

*/*

accessModesarray of string

access Mode lis

capacityobject

clusterVolumeClusterVolume (object)

creationTimestampstring

Example: "2023-04-29 05:54:51"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"v1\",\"kind\":\"PersistentVolumeClaim\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:..."

detailDetail (object)

namestring

Persistent Volume name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

persistentVolumePersistentVolume (object)

persistentVolumeTypestring

Persistent Volume type(SINGLE, SHARED)

Example: "SHARED"

serverParamsarray of ServerParams (object)

Server parameter information

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

Request

JavaScriptCurlPython

const response = await fetch('/v1/clusters/{clusterId}/namespaces/{namespaceName}/persistentvolumeclaims/{pvcName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "accessModes": [
    "ReadWriteMany"
  ],
  "capacity": {
    "storage": "20Gi"
  },
  "clusterVolume": {
    "annotations": {
      "cocktail-user-description": "bmZzLWNzaQ==",
      "meta.helm.sh/release-name": "default-storage",
      "meta.helm.sh/release-namespace": "kube-system"
    },
    "baseStorageYn": "Y",
    "description": "",
    "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": [
      {
        "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",
    "storageType": "NETWORK",
    "totalCapacity": 1024,
    "type": "PERSISTENT_VOLUME",
    "volumeBindingMode": "IMMEDIATE"
  },
  "creationTimestamp": "2023-04-29 05:54:51",
  "deployment": "{\"apiVersion\":\"v1\",\"kind\":\"PersistentVolumeClaim\"...",
  "deploymentYaml": "apiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:...",
  "detail": {
    "accessModes": [
      "ReadWriteMany"
    ],
    "annotations": {
      "meta.helm.sh/release-name": "cocktail",
      "meta.helm.sh/release-namespace": "cocktail-system",
      "pv.kubernetes.io/bind-completed": "yes"
    },
    "capacity": {
      "storage": "20Gi"
    },
    "creationTimestamp": "2023-04-29 05:54:51",
    "labels": {
      "app.kubernetes.io/instance": "cocktail",
      "app.kubernetes.io/managed-by": "Helm",
      "app.kubernetes.io/name": "api-cmdb"
    },
    "name": "cocktail-api-cmdb-logdata",
    "namespace": "cocktail-system",
    "status": "Bound",
    "storageClassName": "nfs-csi",
    "volumeName": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"
  },
  "name": "cocktail-api-cmdb-logdata",
  "namespace": "cocktail-system",
  "persistentVolume": {
    "accessModes": [
      "ReadWriteMany"
    ],
    "capacity": {
      "storage": "20Gi"
    },
    "claimName": "cocktail-api-cmdb-logdata",
    "claimNameWithNamespace": "cocktail-system/cocktail-api-cmdb-logdata",
    "creationTimestamp": "2023-04-29 05:54:51",
    "deployment": "{\"apiVersion\":\"v1\",\"kind\":\"PersistentVolume...",
    "deploymentYaml": "apiVersion: v1\nkind: PersistentVolume\nmetadata...",
    "detail": {
      "accessModes": [
        "ReadWriteMany"
      ],
      "annotations": {
        "pv.kubernetes.io/provisioned-by": "nfs.csi.k8s.io",
        "volume.kubernetes.io/provisioner-deletion-secret-name": "",
        "volume.kubernetes.io/provisioner-deletion-secret-namespace": ""
      },
      "capacity": {
        "storage": "20Gi"
      },
      "claimName": "cocktail-system/cocktail-api-cmdb-logdata",
      "creationTime": "2023-04-29 05:54:51",
      "events": [
        {
          "message": "",
          "source": "",
          "subObject": "",
          "count": 0,
          "firstTime": "2023-04-29 05:54:51",
          "lastTime": "2023-04-29 05:54:51",
          "kind": "",
          "name": "",
          "namespace": "",
          "involvedObject": {
            "apiVersion": "",
            "fieldPath": "",
            "kind": "",
            "name": "",
            "namespace": "",
            "resourceVersion": "",
            "uid": ""
          },
          "related": {
            "apiVersion": "",
            "fieldPath": "",
            "kind": "",
            "name": "",
            "namespace": "",
            "resourceVersion": "",
            "uid": ""
          },
          "deployment": "",
          "deploymentYaml": ""
        }
      ],
      "labels": {
        "app.kubernetes.io/instance": "cocktail",
        "app.kubernetes.io/managed-by": "Helm",
        "app.kubernetes.io/name": "api-cmdb"
      },
      "name": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482",
      "persistentVolumeReclaimPolicy": "Retain",
      "status": "Bound",
      "StatusMessage": "",
      "statusReason": "",
      "storageClassName": "nfs-csi",
      "volumeMode": "",
      "volumeSource": "{\"csi\":{\"driver\":\"nfs.csi.k8s.io\",\"volumeAttributes\":..."
    },
    "name": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482",
    "persistentVolumeReclaimPolicy": "Retain",
    "status": "Bound",
    "storageClassName": "nfs-csi"
  },
  "persistentVolumeType": "SHARED",
  "serverParams": [
    {
      "containerVolumes": [
        {
          "containerName": "api-cmdb",
          "containerPath": "/var/log/mysql",
          "subPath": "api-cmdb",
          "useMemoryYn": "N",
          "volumeName": "log"
        }
      ],
      "namespaceName": "cocktail-system",
      "serverName": "cocktail-api-cmdb"
    }
  ],
  "status": "Bound",
  "storageClassName": "nfs-csi",
  "volumeName": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"
}