Skip to main content

replaceStorageV1StorageClass

replace the specified StorageClass

PUT/apis/storage.k8s.io/v1/storageclasses/{name}
Source
specs/apis__storage.k8s.io__v1_openapi.json
Revision
9a79c3bd90f7
Active snapshot
2a9112600697

Request

Path Parameters
name string
required

name of the StorageClass

Query Parameters
pretty string
optional

If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

dryRun string
optional

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
optional

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
optional

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body Params
required
allowVolumeExpansion boolean
optional

allowVolumeExpansion shows whether the storage class allow volume expand.

allowedTopologies array[io.k8s.api.core.v1.TopologySelectorTerm object]
optional

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

items io.k8s.api.core.v1.TopologySelectorTerm object

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

matchLabelExpressions array[io.k8s.api.core.v1.TopologySelectorLabelRequirement object]
optional

A list of topology selector requirements by labels.

apiVersion string
optional

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
optional

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
optional

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

mountOptions array[string]
optional

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters object
optional

parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner string
required

provisioner indicates the type of the provisioner.

reclaimPolicy string
optional

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

volumeBindingMode string
optional

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

Responses

OK

allowVolumeExpansion boolean
optional

allowVolumeExpansion shows whether the storage class allow volume expand.

allowedTopologies array[io.k8s.api.core.v1.TopologySelectorTerm object]
optional

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

items io.k8s.api.core.v1.TopologySelectorTerm object

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

matchLabelExpressions array[io.k8s.api.core.v1.TopologySelectorLabelRequirement object]
optional

A list of topology selector requirements by labels.

apiVersion string
optional

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
optional

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
optional

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

mountOptions array[string]
optional

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters object
optional

parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner string
required

provisioner indicates the type of the provisioner.

reclaimPolicy string
optional

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

volumeBindingMode string
optional

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

OK

allowVolumeExpansion boolean
optional

allowVolumeExpansion shows whether the storage class allow volume expand.

allowedTopologies array[io.k8s.api.core.v1.TopologySelectorTerm object]
optional

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

items io.k8s.api.core.v1.TopologySelectorTerm object

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

matchLabelExpressions array[io.k8s.api.core.v1.TopologySelectorLabelRequirement object]
optional

A list of topology selector requirements by labels.

apiVersion string
optional

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
optional

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
optional

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

mountOptions array[string]
optional

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters object
optional

parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner string
required

provisioner indicates the type of the provisioner.

reclaimPolicy string
optional

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

volumeBindingMode string
optional

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

application/vnd.kubernetes.protobuf io.k8s.api.storage.v1.StorageClass object

OK

allowVolumeExpansion boolean
optional

allowVolumeExpansion shows whether the storage class allow volume expand.

allowedTopologies array[io.k8s.api.core.v1.TopologySelectorTerm object]
optional

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

items io.k8s.api.core.v1.TopologySelectorTerm object

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

matchLabelExpressions array[io.k8s.api.core.v1.TopologySelectorLabelRequirement object]
optional

A list of topology selector requirements by labels.

apiVersion string
optional

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
optional

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
optional

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

mountOptions array[string]
optional

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters object
optional

parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner string
required

provisioner indicates the type of the provisioner.

reclaimPolicy string
optional

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

volumeBindingMode string
optional

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

OK

allowVolumeExpansion boolean
optional

allowVolumeExpansion shows whether the storage class allow volume expand.

allowedTopologies array[io.k8s.api.core.v1.TopologySelectorTerm object]
optional

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

items io.k8s.api.core.v1.TopologySelectorTerm object

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

matchLabelExpressions array[io.k8s.api.core.v1.TopologySelectorLabelRequirement object]
optional

A list of topology selector requirements by labels.

apiVersion string
optional

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
optional

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
optional

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

mountOptions array[string]
optional

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters object
optional

parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner string
required

provisioner indicates the type of the provisioner.

reclaimPolicy string
optional

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

volumeBindingMode string
optional

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

Created

allowVolumeExpansion boolean
optional

allowVolumeExpansion shows whether the storage class allow volume expand.

allowedTopologies array[io.k8s.api.core.v1.TopologySelectorTerm object]
optional

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

items io.k8s.api.core.v1.TopologySelectorTerm object

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

matchLabelExpressions array[io.k8s.api.core.v1.TopologySelectorLabelRequirement object]
optional

A list of topology selector requirements by labels.

apiVersion string
optional

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
optional

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
optional

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

mountOptions array[string]
optional

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters object
optional

parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner string
required

provisioner indicates the type of the provisioner.

reclaimPolicy string
optional

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

volumeBindingMode string
optional

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

Created

allowVolumeExpansion boolean
optional

allowVolumeExpansion shows whether the storage class allow volume expand.

allowedTopologies array[io.k8s.api.core.v1.TopologySelectorTerm object]
optional

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

items io.k8s.api.core.v1.TopologySelectorTerm object

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

matchLabelExpressions array[io.k8s.api.core.v1.TopologySelectorLabelRequirement object]
optional

A list of topology selector requirements by labels.

apiVersion string
optional

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
optional

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
optional

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

mountOptions array[string]
optional

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters object
optional

parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner string
required

provisioner indicates the type of the provisioner.

reclaimPolicy string
optional

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

volumeBindingMode string
optional

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

application/vnd.kubernetes.protobuf io.k8s.api.storage.v1.StorageClass object

Created

allowVolumeExpansion boolean
optional

allowVolumeExpansion shows whether the storage class allow volume expand.

allowedTopologies array[io.k8s.api.core.v1.TopologySelectorTerm object]
optional

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

items io.k8s.api.core.v1.TopologySelectorTerm object

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

matchLabelExpressions array[io.k8s.api.core.v1.TopologySelectorLabelRequirement object]
optional

A list of topology selector requirements by labels.

apiVersion string
optional

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
optional

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
optional

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

mountOptions array[string]
optional

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters object
optional

parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner string
required

provisioner indicates the type of the provisioner.

reclaimPolicy string
optional

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

volumeBindingMode string
optional

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

Created

allowVolumeExpansion boolean
optional

allowVolumeExpansion shows whether the storage class allow volume expand.

allowedTopologies array[io.k8s.api.core.v1.TopologySelectorTerm object]
optional

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

items io.k8s.api.core.v1.TopologySelectorTerm object

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

matchLabelExpressions array[io.k8s.api.core.v1.TopologySelectorLabelRequirement object]
optional

A list of topology selector requirements by labels.

apiVersion string
optional

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
optional

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
optional

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

mountOptions array[string]
optional

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters object
optional

parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner string
required

provisioner indicates the type of the provisioner.

reclaimPolicy string
optional

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.

volumeBindingMode string
optional

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

Unauthorized