/api/v1/persistentvolumes/{name}

开发中

PUT

replace the specified PersistentVolume

请求参数

Path 参数

name

string

必需

Query 参数

dryRun

string

可选

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

可选

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

fieldValidation

string

可选

fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the ServerSideFieldValidation feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200OK

application/json

Body

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

apiVersion

string

可选

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

可选

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

可选

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

可选

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

clusterName

string

可选

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

creationTimestamp

string <date-time>

可选

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionGracePeriodSeconds

integer <int64>

可选

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp

string <date-time>

可选

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

finalizers

array[string]

可选

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

generateName

string

可选

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation

integer <int64>

可选

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels

object

可选

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

managedFields

array[object (io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry) {7}]

可选

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

name

string

可选

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

string

可选

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

array[object (io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference) {6}]

可选

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

resourceVersion

string

可选

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

string

可选

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

uid

string

可选

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

object (io.k8s.api.core.v1.PersistentVolumeSpec)

可选

PersistentVolumeSpec is the specification of a persistent volume.

accessModes

array[string]

可选

AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

awsElasticBlockStore

object (io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource)

可选

Represents a Persistent Disk resource in AWS.

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

azureDisk

object (io.k8s.api.core.v1.AzureDiskVolumeSource)

可选

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

azureFile

object (io.k8s.api.core.v1.AzureFilePersistentVolumeSource)

可选

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

capacity

object

可选

A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

cephfs

object (io.k8s.api.core.v1.CephFSPersistentVolumeSource)

可选

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

cinder

object (io.k8s.api.core.v1.CinderPersistentVolumeSource)

可选

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

claimRef

object (io.k8s.api.core.v1.ObjectReference)

可选

ObjectReference contains enough information to let you inspect or modify the referred object.

csi

object (io.k8s.api.core.v1.CSIPersistentVolumeSource)

可选

Represents storage that is managed by an external CSI volume driver (Beta feature)

object (io.k8s.api.core.v1.FCVolumeSource)

可选

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

flexVolume

object (io.k8s.api.core.v1.FlexPersistentVolumeSource)

可选

FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.

flocker

object (io.k8s.api.core.v1.FlockerVolumeSource)

可选

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

gcePersistentDisk

object (io.k8s.api.core.v1.GCEPersistentDiskVolumeSource)

可选

Represents a Persistent Disk resource in Google Compute Engine.

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

glusterfs

object (io.k8s.api.core.v1.GlusterfsPersistentVolumeSource)

可选

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

hostPath

object (io.k8s.api.core.v1.HostPathVolumeSource)

可选

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

iscsi

object (io.k8s.api.core.v1.ISCSIPersistentVolumeSource)

可选

ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

local

object (io.k8s.api.core.v1.LocalVolumeSource)

可选

Local represents directly-attached storage with node affinity (Beta feature)

mountOptions

array[string]

可选

A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

nfs

object (io.k8s.api.core.v1.NFSVolumeSource)

可选

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

nodeAffinity

object (io.k8s.api.core.v1.VolumeNodeAffinity)

可选

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

persistentVolumeReclaimPolicy

enum<string>

可选

What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

Possible enum values:

"Delete" means the volume will be deleted from Kubernetes on release from its claim. The volume plugin must support Deletion.

"Recycle" means the volume will be recycled back into the pool of unbound persistent volumes on release from its claim. The volume plugin must support Recycling.

"Retain" means the volume will be left in its current phase (Released) for manual reclamation by the administrator. The default policy is Retain.

枚举值:

DeleteRecycleRetain

photonPersistentDisk

object (io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource)

可选

Represents a Photon Controller persistent disk resource.

portworxVolume

object (io.k8s.api.core.v1.PortworxVolumeSource)

可选

PortworxVolumeSource represents a Portworx volume resource.

quobyte

object (io.k8s.api.core.v1.QuobyteVolumeSource)

可选

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

rbd

object (io.k8s.api.core.v1.RBDPersistentVolumeSource)

可选

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

scaleIO

object (io.k8s.api.core.v1.ScaleIOPersistentVolumeSource)

可选

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

storageClassName

string

可选

Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.

storageos

object (io.k8s.api.core.v1.StorageOSPersistentVolumeSource)

可选

Represents a StorageOS persistent volume resource.

volumeMode

string

可选

volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.

vsphereVolume

object (io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource)

可选

Represents a vSphere volume resource.

status

object (io.k8s.api.core.v1.PersistentVolumeStatus)

可选

PersistentVolumeStatus is the current status of a persistent volume.

message

string

可选

A human-readable message indicating details about why the volume is in this state.

phase

enum<string>

可选

Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase

Possible enum values:

"Available" used for PersistentVolumes that are not yet bound Available volumes are held by the binder and matched to PersistentVolumeClaims

"Bound" used for PersistentVolumes that are bound

"Failed" used for PersistentVolumes that failed to be correctly recycled or deleted after being released from a claim

"Pending" used for PersistentVolumes that are not available

"Released" used for PersistentVolumes where the bound PersistentVolumeClaim was deleted released volumes must be recycled before becoming available again this phase is used by the persistent volume claim binder to signal to another process to reclaim the resource

枚举值:

AvailableBoundFailedPendingReleased

reason

string

可选

Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

示例

{
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
        "annotations": {
            "property1": "string",
            "property2": "string"
        },
        "clusterName": "string",
        "creationTimestamp": "2019-08-24T14:15:22Z",
        "deletionGracePeriodSeconds": 0,
        "deletionTimestamp": "2019-08-24T14:15:22Z",
        "finalizers": [
            "string"
        ],
        "generateName": "string",
        "generation": 0,
        "labels": {
            "property1": "string",
            "property2": "string"
        },
        "managedFields": [
            {
                "apiVersion": "string",
                "fieldsType": "string",
                "fieldsV1": {},
                "manager": "string",
                "operation": "string",
                "subresource": "string",
                "time": "2019-08-24T14:15:22Z"
            }
        ],
        "name": "string",
        "namespace": "string",
        "ownerReferences": [
            {
                "apiVersion": "string",
                "blockOwnerDeletion": true,
                "controller": true,
                "kind": "string",
                "name": "string",
                "uid": "string"
            }
        ],
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
    },
    "spec": {
        "accessModes": [
            "string"
        ],
        "awsElasticBlockStore": {
            "fsType": "string",
            "partition": 0,
            "readOnly": true,
            "volumeID": "string"
        },
        "azureDisk": {
            "cachingMode": "string",
            "diskName": "string",
            "diskURI": "string",
            "fsType": "string",
            "kind": "string",
            "readOnly": true
        },
        "azureFile": {
            "readOnly": true,
            "secretName": "string",
            "secretNamespace": "string",
            "shareName": "string"
        },
        "capacity": {
            "property1": "string",
            "property2": "string"
        },
        "cephfs": {
            "monitors": [
                "string"
            ],
            "path": "string",
            "readOnly": true,
            "secretFile": "string",
            "secretRef": {
                "name": "string",
                "namespace": "string"
            },
            "user": "string"
        },
        "cinder": {
            "fsType": "string",
            "readOnly": true,
            "secretRef": {
                "name": "string",
                "namespace": "string"
            },
            "volumeID": "string"
        },
        "claimRef": {
            "apiVersion": "string",
            "fieldPath": "string",
            "kind": "string",
            "name": "string",
            "namespace": "string",
            "resourceVersion": "string",
            "uid": "string"
        },
        "csi": {
            "controllerExpandSecretRef": {
                "name": "string",
                "namespace": "string"
            },
            "controllerPublishSecretRef": {
                "name": "string",
                "namespace": "string"
            },
            "driver": "string",
            "fsType": "string",
            "nodePublishSecretRef": {
                "name": "string",
                "namespace": "string"
            },
            "nodeStageSecretRef": {
                "name": "string",
                "namespace": "string"
            },
            "readOnly": true,
            "volumeAttributes": {
                "property1": "string",
                "property2": "string"
            },
            "volumeHandle": "string"
        },
        "fc": {
            "fsType": "string",
            "lun": 0,
            "readOnly": true,
            "targetWWNs": [
                "string"
            ],
            "wwids": [
                "string"
            ]
        },
        "flexVolume": {
            "driver": "string",
            "fsType": "string",
            "options": {
                "property1": "string",
                "property2": "string"
            },
            "readOnly": true,
            "secretRef": {
                "name": "string",
                "namespace": "string"
            }
        },
        "flocker": {
            "datasetName": "string",
            "datasetUUID": "string"
        },
        "gcePersistentDisk": {
            "fsType": "string",
            "partition": 0,
            "pdName": "string",
            "readOnly": true
        },
        "glusterfs": {
            "endpoints": "string",
            "endpointsNamespace": "string",
            "path": "string",
            "readOnly": true
        },
        "hostPath": {
            "path": "string",
            "type": "string"
        },
        "iscsi": {
            "chapAuthDiscovery": true,
            "chapAuthSession": true,
            "fsType": "string",
            "initiatorName": "string",
            "iqn": "string",
            "iscsiInterface": "string",
            "lun": 0,
            "portals": [
                "string"
            ],
            "readOnly": true,
            "secretRef": {
                "name": "string",
                "namespace": "string"
            },
            "targetPortal": "string"
        },
        "local": {
            "fsType": "string",
            "path": "string"
        },
        "mountOptions": [
            "string"
        ],
        "nfs": {
            "path": "string",
            "readOnly": true,
            "server": "string"
        },
        "nodeAffinity": {
            "required": {
                "nodeSelectorTerms": [
                    {
                        "matchExpressions": [
                            {
                                "key": "string",
                                "operator": "DoesNotExist",
                                "values": [
                                    "string"
                                ]
                            }
                        ],
                        "matchFields": [
                            {
                                "key": "string",
                                "operator": "DoesNotExist",
                                "values": [
                                    "string"
                                ]
                            }
                        ]
                    }
                ]
            }
        },
        "persistentVolumeReclaimPolicy": "Delete",
        "photonPersistentDisk": {
            "fsType": "string",
            "pdID": "string"
        },
        "portworxVolume": {
            "fsType": "string",
            "readOnly": true,
            "volumeID": "string"
        },
        "quobyte": {
            "group": "string",
            "readOnly": true,
            "registry": "string",
            "tenant": "string",
            "user": "string",
            "volume": "string"
        },
        "rbd": {
            "fsType": "string",
            "image": "string",
            "keyring": "string",
            "monitors": [
                "string"
            ],
            "pool": "string",
            "readOnly": true,
            "secretRef": {
                "name": "string",
                "namespace": "string"
            },
            "user": "string"
        },
        "scaleIO": {
            "fsType": "string",
            "gateway": "string",
            "protectionDomain": "string",
            "readOnly": true,
            "secretRef": {
                "name": "string",
                "namespace": "string"
            },
            "sslEnabled": true,
            "storageMode": "string",
            "storagePool": "string",
            "system": "string",
            "volumeName": "string"
        },
        "storageClassName": "string",
        "storageos": {
            "fsType": "string",
            "readOnly": true,
            "secretRef": {
                "apiVersion": "string",
                "fieldPath": "string",
                "kind": "string",
                "name": "string",
                "namespace": "string",
                "resourceVersion": "string",
                "uid": "string"
            },
            "volumeName": "string",
            "volumeNamespace": "string"
        },
        "volumeMode": "string",
        "vsphereVolume": {
            "fsType": "string",
            "storagePolicyID": "string",
            "storagePolicyName": "string",
            "volumePath": "string"
        }
    },
    "status": {
        "message": "string",
        "phase": "Available",
        "reason": "string"
    }
}

🟢201Created

🟠401Unauthorized

修改于 2022-07-15 03:18:11

/api/v1/persistentvolumes/{name}

/api/v1/persistentvolumes/{name}/status