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

Body

accessModesarray of string

access Mode lis

itemsstring

Example: "ReadWriteMany"

capacityobject

additionalPropstring

clusterVolumeClusterVolume (object)

annotationsobject

additionalPropstring

baseStorageYnstring

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

Example: "Y"

descriptionstring

Example: ""

labelsobject

additionalPropstring

mountOptionsarray of string

Cluster volume mount options list

itemsstring

namestring

PVC name

Example: "nfs-csi"

parametersarray of object

Parameter list

namestring

Parameter name

valuestring

Parameter value

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

Support for ReadOnlyMany volume requests (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteManyYnstring

Support for ReadWriteMany volume requests (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteOnceYnstring

Support for readWriteOnceYn volume requests (Y: Allowed, N: Not allowed)

Example: "Y"

reclaimPolicystring

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

Example: "RETAIN"

storageTypestring

storage Type(NETWORK, BLOCK)

Example: "NETWORK"

totalCapacityinteger

Example: 1024

typestring

type(PERSISTENT_VOLUME, PERSISTENT_VOLUME_STATIC)

Example: "PERSISTENT_VOLUME"

volumeBindingModestring

volumeBindingMode(IMMEDIATE, WAIT_FOR_FIRST_CONSUMER, IMMEDIATE, WAIT_FOR_FIRST_CONSUMER)

Example: "IMMEDIATE"

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)

accessModesarray of string

access Mode list

itemsstring

Example: "ReadWriteMany"

annotationsobject

additionalPropstring

capacityobject

additionalPropstring

creationTimestampstring

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

labelsobject

additionalPropstring

namestring

Persistent Volume name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

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

namestring

Persistent Volume name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

persistentVolumePersistentVolume (object)

accessModesarray of string

access Mode list

itemsstring

Example: "ReadWriteMany"

capacityobject

additionalPropstring

claimNamestring

PVC name

Example: "cocktail-api-cmdb-logdata"

claimNameWithNamespacestring

PVC name with namespace

Example: "cocktail-system/cocktail-api-cmdb-logdata"

creationTimestampstring

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

deploymentstring

deployment information

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

deploymentYamlstring

deployment information(YAML)

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

detailobject

Detailed information

additionalPropany

namestring

Volume name

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

persistentVolumeReclaimPolicystring

Reclaim policy name

Example: "Retain"

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

persistentVolumeTypestring

Persistent Volume type(SINGLE, SHARED)

Example: "SHARED"

serverParamsarray of ServerParams (object)

Server parameter information

containerVolumesarray of object

Container volume information

additionalPropany

namespaceNamestring

Example: "cocktail-system"

serverNamestring

Example: "cocktail-api-cmdb"

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

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

Request

Response