v1.PersistentVolume

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

Description

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

Object Schema

Expand or mouse-over a field for more information about it.

apiVersion:
kind:
metadata:
  annotations:
    [string]:
  clusterName:
  creationTimestamp:
  deletionGracePeriodSeconds:
  deletionTimestamp:
  finalizers:
  - [string]:
  generateName:
  generation:
  initializers:
    pending:
    - name:
    result:
      apiVersion:
      code:
      details:
        causes:
        - field:
          message:
          reason:
        group:
        kind:
        name:
        retryAfterSeconds:
        uid:
      kind:
      message:
      metadata:
        resourceVersion:
        selfLink:
      reason:
      status:
  labels:
    [string]:
  name:
  namespace:
  ownerReferences:
  - apiVersion:
    blockOwnerDeletion:
    controller:
    kind:
    name:
    uid:
  resourceVersion:
  selfLink:
  uid:
spec:
  accessModes:
  - [string]:
  awsElasticBlockStore:
    fsType:
    partition:
    readOnly:
    volumeID:
  azureDisk:
    cachingMode:
    diskName:
    diskURI:
    fsType:
    kind:
    readOnly:
  azureFile:
    readOnly:
    secretName:
    shareName:
  capacity:
    [string]:
  cephfs:
    monitors:
    - [string]:
    path:
    readOnly:
    secretFile:
    secretRef:
      name:
    user:
  cinder:
    fsType:
    readOnly:
    volumeID:
  claimRef:
    apiVersion:
    fieldPath:
    kind:
    name:
    namespace:
    resourceVersion:
    uid:
  fc:
    fsType:
    lun:
    readOnly:
    targetWWNs:
    - [string]:
  flexVolume:
    driver:
    fsType:
    options:
      [string]:
    readOnly:
    secretRef:
      name:
  flocker:
    datasetName:
    datasetUUID:
  gcePersistentDisk:
    fsType:
    partition:
    pdName:
    readOnly:
  glusterfs:
    endpoints:
    path:
    readOnly:
  hostPath:
    path:
  iscsi:
    chapAuthDiscovery:
    chapAuthSession:
    fsType:
    iqn:
    iscsiInterface:
    lun:
    portals:
    - [string]:
    readOnly:
    secretRef:
      name:
    targetPortal:
  local:
    path:
  nfs:
    path:
    readOnly:
    server:
  persistentVolumeReclaimPolicy:
  photonPersistentDisk:
    fsType:
    pdID:
  portworxVolume:
    fsType:
    readOnly:
    volumeID:
  quobyte:
    group:
    readOnly:
    registry:
    user:
    volume:
  rbd:
    fsType:
    image:
    keyring:
    monitors:
    - [string]:
    pool:
    readOnly:
    secretRef:
      name:
    user:
  scaleIO:
    fsType:
    gateway:
    protectionDomain:
    readOnly:
    secretRef:
      name:
    sslEnabled:
    storageMode:
    storagePool:
    system:
    volumeName:
  storageClassName:
  storageos:
    fsType:
    readOnly:
    secretRef:
      apiVersion:
      fieldPath:
      kind:
      name:
      namespace:
      resourceVersion:
      uid:
    volumeName:
    volumeNamespace:
  vsphereVolume:
    fsType:
    storagePolicyID:
    storagePolicyName:
    volumePath:
status:
  message:
  phase:
  reason:

Operations

Create a PersistentVolume

Create a PersistentVolume

HTTP request

POST /api/v1/persistentvolumes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "PersistentVolume",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/persistentvolumes <<'EOF'
{
  "kind": "PersistentVolume",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get a PersistentVolume

Read the specified PersistentVolume

HTTP request

GET /api/v1/persistentvolumes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/persistentvolumes/$NAME

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get all PersistentVolumes

List or watch objects of kind PersistentVolume

HTTP request

GET /api/v1/persistentvolumes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/persistentvolumes

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

Watch a PersistentVolume

Watch changes to an object of kind PersistentVolume

HTTP request

GET /api/v1/watch/persistentvolumes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/watch/persistentvolumes/$NAME

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

Watch all PersistentVolumes

Watch individual changes to a list of PersistentVolume

HTTP request

GET /api/v1/watch/persistentvolumes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/watch/persistentvolumes

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

Update a PersistentVolume

Replace the specified PersistentVolume

HTTP request

PUT /api/v1/persistentvolumes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "PersistentVolume",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/persistentvolumes/$NAME <<'EOF'
{
  "kind": "PersistentVolume",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Patch a PersistentVolume

Partially update the specified PersistentVolume

HTTP request

PATCH /api/v1/persistentvolumes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/api/v1/persistentvolumes/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• application/json-patch+json

• application/merge-patch+json

• application/strategic-merge-patch+json

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Delete a PersistentVolume

Delete a PersistentVolume

HTTP request

DELETE /api/v1/persistentvolumes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  ...
}

Curl request

$ curl -k \
    -X DELETE \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/persistentvolumes/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Delete all PersistentVolumes

Delete collection of PersistentVolume

HTTP request

DELETE /api/v1/persistentvolumes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/persistentvolumes

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get status of a PersistentVolume

Read status of the specified PersistentVolume

HTTP request

GET /api/v1/persistentvolumes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/persistentvolumes/$NAME/status

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Update status of a PersistentVolume

Replace status of the specified PersistentVolume

HTTP request

PUT /api/v1/persistentvolumes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "PersistentVolume",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/persistentvolumes/$NAME/status <<'EOF'
{
  "kind": "PersistentVolume",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Patch status of a PersistentVolume

Partially update status of the specified PersistentVolume

HTTP request

PATCH /api/v1/persistentvolumes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/api/v1/persistentvolumes/$NAME/status <<'EOF'
{
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• application/json-patch+json

• application/merge-patch+json

• application/strategic-merge-patch+json

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf