This is a cache of https://docs.okd.io/3.10/rest_api/api/v1.PersistentVolume.html. It is a snapshot of the page at 2024-11-18T04:04:21.675+0000.
v1.PersistentVolume - /<strong>api</strong>/v1 | REST <strong>api</strong> Reference | OKD 3.10
  1. Documentation
×

v1.PersistentVolume

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

Parameter Schema

body

v1.PersistentVolume

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.PersistentVolume

401 Unauthorized

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

Parameter Description

name

name of the PersistentVolume

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

export

Should this value be exported. Export strips fields that a user can not specify.

Responses

HTTP Code Schema

200 OK

v1.PersistentVolume

401 Unauthorized

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

Parameter Description

pretty

If 'true', then the output is pretty printed.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.PersistentVolumeList

401 Unauthorized

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

Parameter Description

name

name of the PersistentVolume

Query parameters

Parameter Description

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

pretty

If 'true', then the output is pretty printed.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

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

Parameter Description

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

pretty

If 'true', then the output is pretty printed.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

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

Parameter Schema

body

v1.PersistentVolume

Path parameters

Parameter Description

name

name of the PersistentVolume

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.PersistentVolume

401 Unauthorized

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

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the PersistentVolume

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.PersistentVolume

401 Unauthorized

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

Parameter Schema

body

v1.DeleteOptions

Path parameters

Parameter Description

name

name of the PersistentVolume

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

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

Parameter Description

pretty

If 'true', then the output is pretty printed.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

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

Parameter Description

name

name of the PersistentVolume

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.PersistentVolume

401 Unauthorized

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

Parameter Schema

body

v1.PersistentVolume

Path parameters

Parameter Description

name

name of the PersistentVolume

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.PersistentVolume

401 Unauthorized

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

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the PersistentVolume

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.PersistentVolume

401 Unauthorized

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf