Easily Switch Between Product Types
You can click the drop-down list box to switch between different product types.
Replacing PVCs
Function
This API is used to replacing a specified PVC.
The following fields can be updated:
-
metadata.labels
-
metadata.annotations
-
metadata.generateName
Other fields cannot be updated.
Calling Method
For details, see Calling APIs.
URI
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
name of the PersistentVolumeClaim |
|
namespace |
Yes |
String |
object name and auth scope, such as for teams and projects |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
dryRun |
No |
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 |
No |
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. |
|
pretty |
No |
String |
If 'true', then the output is pretty printed. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
|
Content-Type |
Yes |
String |
Message body type (format). The default value is application/json. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
apiVersion |
No |
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 |
No |
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 |
No |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
spec |
No |
Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
status |
No |
Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
annotations |
No |
Map<String,String> |
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 |
No |
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 |
No |
String |
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 |
No |
Long |
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 |
No |
String |
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 |
No |
Array of strings |
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 |
No |
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 |
No |
Long |
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
|
labels |
No |
Map<String,String> |
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 |
No |
Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects |
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 |
No |
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 |
No |
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 |
No |
Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects |
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 |
No |
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 |
No |
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 |
No |
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
apiVersion |
No |
String |
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. |
|
fieldsType |
No |
String |
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" |
|
fieldsV1 |
No |
Object |
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. |
|
manager |
No |
String |
Manager is an identifier of the workflow managing these fields. |
|
operation |
No |
String |
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. |
|
time |
No |
String |
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
apiVersion |
Yes |
String |
API version of the referent. |
|
blockOwnerDeletion |
No |
Boolean |
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
|
controller |
No |
Boolean |
If true, this reference points to the managing controller. |
|
kind |
Yes |
String |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
name |
Yes |
String |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
|
uid |
Yes |
String |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
accessModes |
No |
Array of strings |
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
dataSource |
No |
This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change. |
|
|
resources |
No |
Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
|
selector |
No |
A label query over volumes to consider for binding. |
|
|
storageClassName |
No |
String |
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
volumeMode |
No |
String |
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
volumeName |
No |
String |
VolumeName is the binding reference to the PersistentVolume backing this claim. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
apiGroup |
No |
String |
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
kind |
Yes |
String |
Kind is the type of resource being referenced |
|
name |
Yes |
String |
Name is the name of resource being referenced |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limits |
No |
Map<String,String> |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
requests |
No |
Map<String,String> |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
matchExpressions |
No |
Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
matchLabels |
No |
Map<String,String> |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
key |
Yes |
String |
key is the label key that the selector applies to. |
|
operator |
Yes |
String |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
values |
No |
Array of strings |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
accessModes |
No |
Array of strings |
AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
capacity |
No |
Map<String,String> |
Represents the actual resources of the underlying volume. |
|
conditions |
No |
Array of io.k8s.api.core.v1.PersistentVolumeClaimCondition objects |
Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. |
|
phase |
No |
String |
Phase represents the current phase of PersistentVolumeClaim. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
lastProbeTime |
No |
String |
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. |
|
lastTransitionTime |
No |
String |
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. |
|
message |
No |
String |
Human-readable message indicating details about last transition. |
|
reason |
No |
String |
Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. |
|
status |
Yes |
String |
status is the status of the condition. |
|
type |
Yes |
String |
type is the type of the condition. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
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 |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
spec |
Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
status |
Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
Parameter |
Type |
Description |
|---|---|---|
|
annotations |
Map<String,String> |
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 |
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 |
Long |
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 |
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 of strings |
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 |
Long |
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
|
labels |
Map<String,String> |
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 of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects |
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 of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects |
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 |
|
Parameter |
Type |
Description |
|---|---|---|
|
apiVersion |
String |
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. |
|
fieldsType |
String |
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" |
|
fieldsV1 |
Object |
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. |
|
manager |
String |
Manager is an identifier of the workflow managing these fields. |
|
operation |
String |
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. |
|
time |
String |
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. |
|
Parameter |
Type |
Description |
|---|---|---|
|
apiVersion |
String |
API version of the referent. |
|
blockOwnerDeletion |
Boolean |
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
|
controller |
Boolean |
If true, this reference points to the managing controller. |
|
kind |
String |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
name |
String |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
|
uid |
String |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
|
Parameter |
Type |
Description |
|---|---|---|
|
accessModes |
Array of strings |
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
dataSource |
This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change. |
|
|
resources |
Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
|
selector |
A label query over volumes to consider for binding. |
|
|
storageClassName |
String |
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
volumeMode |
String |
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
volumeName |
String |
VolumeName is the binding reference to the PersistentVolume backing this claim. |
|
Parameter |
Type |
Description |
|---|---|---|
|
apiGroup |
String |
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
kind |
String |
Kind is the type of resource being referenced |
|
name |
String |
Name is the name of resource being referenced |
|
Parameter |
Type |
Description |
|---|---|---|
|
limits |
Map<String,String> |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
requests |
Map<String,String> |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
Parameter |
Type |
Description |
|---|---|---|
|
matchExpressions |
Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
matchLabels |
Map<String,String> |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
String |
key is the label key that the selector applies to. |
|
operator |
String |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
values |
Array of strings |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
|
Parameter |
Type |
Description |
|---|---|---|
|
accessModes |
Array of strings |
AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
capacity |
Map<String,String> |
Represents the actual resources of the underlying volume. |
|
conditions |
Array of io.k8s.api.core.v1.PersistentVolumeClaimCondition objects |
Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. |
|
phase |
String |
Phase represents the current phase of PersistentVolumeClaim. |
|
Parameter |
Type |
Description |
|---|---|---|
|
lastProbeTime |
String |
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. |
|
lastTransitionTime |
String |
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. |
|
message |
String |
Human-readable message indicating details about last transition. |
|
reason |
String |
Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. |
|
status |
String |
status is the status of the condition. |
|
type |
String |
type is the type of the condition. |
Status code: 201
|
Parameter |
Type |
Description |
|---|---|---|
|
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 |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
spec |
Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
status |
Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
Parameter |
Type |
Description |
|---|---|---|
|
annotations |
Map<String,String> |
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 |
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 |
Long |
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 |
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 of strings |
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 |
Long |
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
|
labels |
Map<String,String> |
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 of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects |
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 of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects |
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 |
|
Parameter |
Type |
Description |
|---|---|---|
|
apiVersion |
String |
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. |
|
fieldsType |
String |
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" |
|
fieldsV1 |
Object |
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. |
|
manager |
String |
Manager is an identifier of the workflow managing these fields. |
|
operation |
String |
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. |
|
time |
String |
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. |
|
Parameter |
Type |
Description |
|---|---|---|
|
apiVersion |
String |
API version of the referent. |
|
blockOwnerDeletion |
Boolean |
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
|
controller |
Boolean |
If true, this reference points to the managing controller. |
|
kind |
String |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
name |
String |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
|
uid |
String |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
|
Parameter |
Type |
Description |
|---|---|---|
|
accessModes |
Array of strings |
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
dataSource |
This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change. |
|
|
resources |
Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
|
selector |
A label query over volumes to consider for binding. |
|
|
storageClassName |
String |
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
volumeMode |
String |
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
volumeName |
String |
VolumeName is the binding reference to the PersistentVolume backing this claim. |
|
Parameter |
Type |
Description |
|---|---|---|
|
apiGroup |
String |
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
|
kind |
String |
Kind is the type of resource being referenced |
|
name |
String |
Name is the name of resource being referenced |
|
Parameter |
Type |
Description |
|---|---|---|
|
limits |
Map<String,String> |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
requests |
Map<String,String> |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
Parameter |
Type |
Description |
|---|---|---|
|
matchExpressions |
Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
matchLabels |
Map<String,String> |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
String |
key is the label key that the selector applies to. |
|
operator |
String |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
values |
Array of strings |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
|
Parameter |
Type |
Description |
|---|---|---|
|
accessModes |
Array of strings |
AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
capacity |
Map<String,String> |
Represents the actual resources of the underlying volume. |
|
conditions |
Array of io.k8s.api.core.v1.PersistentVolumeClaimCondition objects |
Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. |
|
phase |
String |
Phase represents the current phase of PersistentVolumeClaim. |
|
Parameter |
Type |
Description |
|---|---|---|
|
lastProbeTime |
String |
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. |
|
lastTransitionTime |
String |
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. |
|
message |
String |
Human-readable message indicating details about last transition. |
|
reason |
String |
Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. |
|
status |
String |
status is the status of the condition. |
|
type |
String |
type is the type of the condition. |
Example Requests
Updating metadata.labels for PVCs
{
"apiVersion" : "v1",
"kind" : "PersistentVolumeClaim",
"metadata" : {
"annotations" : {
"everest.io/disk-volume-type" : "SATA",
"pv.kubernetes.io/bind-completed" : "yes",
"pv.kubernetes.io/bound-by-controller" : "yes",
"volume.beta.kubernetes.io/storage-provisioner" : "everest-csi-provisioner"
},
"creationTimestamp" : "2023-06-25T02:59:26Z",
"finalizers" : [ "kubernetes.io/pvc-protection" ],
"labels" : {
"failure-domain.beta.kubernetes.io/region" : "cn-north-7",
"failure-domain.beta.kubernetes.io/zone" : "cn-north-7a"
},
"name" : "pvc-test",
"namespace" : "test-namespace",
"resourceVersion" : "343613181",
"selfLink" : "/api/v1/namespaces/test-namespace/persistentvolumeclaims/pvc-test",
"uid" : "bb99f33d-a5da-46b4-90a4-b0c6b3eedabf"
},
"spec" : {
"accessModes" : [ "ReadWriteMany" ],
"resources" : {
"requests" : {
"storage" : "10Gi"
}
},
"storageClassName" : "sata",
"volumeMode" : "Filesystem",
"volumeName" : "pvc-bb99f33d-a5da-46b4-90a4-b0c6b3eedabf"
}
}Example Responses
Status code: 200
OK
{
"apiVersion" : "v1",
"kind" : "PersistentVolumeClaim",
"metadata" : {
"annotations" : {
"everest.io/disk-volume-type" : "SATA",
"pv.kubernetes.io/bind-completed" : "yes",
"pv.kubernetes.io/bound-by-controller" : "yes",
"volume.beta.kubernetes.io/storage-provisioner" : "everest-csi-provisioner"
},
"creationTimestamp" : "2023-06-25T02:59:26Z",
"finalizers" : [ "kubernetes.io/pvc-protection" ],
"labels" : {
"failure-domain.beta.kubernetes.io/region" : "cn-north-7",
"failure-domain.beta.kubernetes.io/zone" : "cn-north-7a"
},
"name" : "pvc-test",
"namespace" : "test-namespace",
"resourceVersion" : "343622839",
"selfLink" : "/api/v1/namespaces/test-namespace/persistentvolumeclaims/pvc-test",
"uid" : "bb99f33d-a5da-46b4-90a4-b0c6b3eedabf"
},
"spec" : {
"accessModes" : [ "ReadWriteMany" ],
"resources" : {
"requests" : {
"storage" : "10Gi"
}
},
"storageClassName" : "sata",
"volumeMode" : "Filesystem",
"volumeName" : "pvc-bb99f33d-a5da-46b4-90a4-b0c6b3eedabf"
},
"status" : {
"accessModes" : [ "ReadWriteMany" ],
"capacity" : {
"storage" : "10Gi"
},
"phase" : "Bound"
}
}Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
201 |
Created |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
NotFound |
|
405 |
MethodNotAllowed |
|
406 |
NotAcceptable |
|
409 |
Conflict |
|
415 |
UnsupportedMediaType |
|
422 |
Invalid |
|
429 |
TooManyRequests |
|
500 |
InternalError |
|
503 |
ServiceUnavailable |
|
504 |
ServerTimeout |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
