kubernetes reference title CSIStorageCapacity weight 5 contenttype apireference kind CSIStorageCapacity apimetadata apiVersion storage k8s io v1 CSIStorageCapacity stores the result of one CSI GetCapacity call autogenerated true import k8s io api storage v1

Answer:
---
api_metadata:
  apiVersion: "storage.k8s.io/v1"
  import: "k8s.io/api/storage/v1"
  kind: "CSIStorageCapacity"
content_type: "api_reference"
description: "CSIStorageCapacity stores the result of one CSI GetCapacity call."
title: "CSIStorageCapacity"
weight: 5
auto_generated: true
---

`apiVersion: storage.k8s.io/v1`

`import "k8s.io/api/storage/v1"`

## CSIStorageCapacity {#CSIStorageCapacity}

CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment.  This can be used when considering where to instantiate new PersistentVolumes.

For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123"

The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero

The producer of these objects can decide which approach is more suitable.

They are consumed by the kube-scheduler when a CSI driver opts into capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back to a comparison against the less precise Capacity. If that is also unset, the scheduler assumes that capacity is insufficient and tries some other node.

- **apiVersion**: storage.k8s.io/v1

- **kind**: CSIStorageCapacity

- **metadata** (ObjectMeta)

  Standard object's metadata. The name has no particular meaning. It must be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-\<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name.

  Objects are namespaced.

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

- **storageClassName** (string), required

  storageClassName represents the name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.

- **capacity** (Quantity)

  capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.

  The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable.

- **maximumVolumeSize** (Quantity)

  maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.

  This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.

- **nodeTopology** (LabelSelector)

  nodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.

## CSIStorageCapacityList {#CSIStorageCapacityList}

CSIStorageCapacityList is a collection of CSIStorageCapacity objects.

- **apiVersion**: storage.k8s.io/v1

- **kind**: CSIStorageCapacityList

- **metadata** (ListMeta)

  Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **items** ([]CSIStorageCapacity), required

  items is the list of CSIStorageCapacity objects.

## Operations {#Operations}

### `get` read the specified CSIStorageCapacity

#### HTTP Request

GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the CSIStorageCapacity

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (CSIStorageCapacity): OK

401: Unauthorized

### `list` list or watch objects of kind CSIStorageCapacity

#### HTTP Request

GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (CSIStorageCapacityList): OK

401: Unauthorized

### `list` list or watch objects of kind CSIStorageCapacity

#### HTTP Request

GET /apis/storage.k8s.io/v1/csistoragecapacities

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (CSIStorageCapacityList): OK

401: Unauthorized

### `create` create a CSIStorageCapacity

#### HTTP Request

POST /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: CSIStorageCapacity, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (CSIStorageCapacity): OK

201 (CSIStorageCapacity): Created

202 (CSIStorageCapacity): Accepted

401: Unauthorized

### `update` replace the specified CSIStorageCapacity

#### HTTP Request

PUT /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the CSIStorageCapacity

- **namespace** (*in path*): string, required

  namespace

- **body**: CSIStorageCapacity, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (CSIStorageCapacity): OK

201 (CSIStorageCapacity): Created

401: Unauthorized

### `patch` partially update the specified CSIStorageCapacity

#### HTTP Request

PATCH /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the CSIStorageCapacity

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (CSIStorageCapacity): OK

201 (CSIStorageCapacity): Created

401: Unauthorized

### `delete` delete a CSIStorageCapacity

#### HTTP Request

DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the CSIStorageCapacity

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

### `deletecollection` delete collection of CSIStorageCapacity

#### HTTP Request

DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   storage k8s io v1    import   k8s io api storage v1    kind   CSIStorageCapacity  content type   api reference  description   CSIStorageCapacity stores the result of one CSI GetCapacity call   title   CSIStorageCapacity  weight  5 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  storage k8s io v1    import  k8s io api storage v1        CSIStorageCapacity   CSIStorageCapacity   CSIStorageCapacity stores the result of one CSI GetCapacity call  For a given StorageClass  this describes the available capacity in a particular topology segment   This can be used when considering where to instantiate new PersistentVolumes   For example this can express things like    StorageClass  standard  has  1234 GiB  available in  topology kubernetes io zone us east1    StorageClass  localssd  has  10 GiB  available in  kubernetes io hostname knode abc123   The following three cases all imply that no capacity is available for a certain combination    no object exists with suitable topology and storage class name   such an object exists  but the capacity is unset   such an object exists  but the capacity is zero  The producer of these objects can decide which approach is more suitable   They are consumed by the kube scheduler when a CSI driver opts into capacity aware scheduling with CSIDriverSpec StorageCapacity  The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes  If MaximumVolumeSize is unset  it falls back to a comparison against the less precise Capacity  If that is also unset  the scheduler assumes that capacity is insufficient and tries some other node    hr       apiVersion    storage k8s io v1       kind    CSIStorageCapacity       metadata     a href    ObjectMeta  a      Standard object s metadata  The name has no particular meaning  It must be a DNS subdomain  dots allowed  253 characters   To ensure that there are no conflicts with other CSI drivers on the cluster  the recommendation is to use csisc   uuid   a generated name  or a reverse domain name which ends with the unique CSI driver name       Objects are namespaced       More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      storageClassName    string   required    storageClassName represents the name of the StorageClass that the reported capacity applies to  It must meet the same requirements as the name of a StorageClass object  non empty  DNS subdomain   If that object no longer exists  the CSIStorageCapacity object is obsolete and should be removed by its creator  This field is immutable       capacity     a href    Quantity  a      capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields       The semantic is currently  CSI spec 1 2  defined as  The available capacity  in bytes  of the storage that can be used to provision volumes  If not set  that information is currently unavailable       maximumVolumeSize     a href    Quantity  a      maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields       This is defined since CSI spec 1 4 0 as the largest size that may be used in a CreateVolumeRequest capacity range required bytes field to create a volume with the same parameters as those in GetCapacityRequest  The corresponding value in the Kubernetes API is ResourceRequirements Requests in a volume claim       nodeTopology     a href    LabelSelector  a      nodeTopology defines which nodes have access to the storage for which capacity was reported  If not set  the storage is not accessible from any node in the cluster  If empty  the storage is accessible from all nodes  This field is immutable          CSIStorageCapacityList   CSIStorageCapacityList   CSIStorageCapacityList is a collection of CSIStorageCapacity objects    hr       apiVersion    storage k8s io v1       kind    CSIStorageCapacityList       metadata     a href    ListMeta  a      Standard list metadata More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      items       a href    CSIStorageCapacity  a    required    items is the list of CSIStorageCapacity objects          Operations   Operations      hr             get  read the specified CSIStorageCapacity       HTTP Request  GET  apis storage k8s io v1 namespaces  namespace  csistoragecapacities  name        Parameters       name     in path    string  required    name of the CSIStorageCapacity       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    CSIStorageCapacity  a    OK  401  Unauthorized        list  list or watch objects of kind CSIStorageCapacity       HTTP Request  GET  apis storage k8s io v1 namespaces  namespace  csistoragecapacities       Parameters       namespace     in path    string  required     a href    namespace  a        allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    CSIStorageCapacityList  a    OK  401  Unauthorized        list  list or watch objects of kind CSIStorageCapacity       HTTP Request  GET  apis storage k8s io v1 csistoragecapacities       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    CSIStorageCapacityList  a    OK  401  Unauthorized        create  create a CSIStorageCapacity       HTTP Request  POST  apis storage k8s io v1 namespaces  namespace  csistoragecapacities       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    CSIStorageCapacity  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    CSIStorageCapacity  a    OK  201   a href    CSIStorageCapacity  a    Created  202   a href    CSIStorageCapacity  a    Accepted  401  Unauthorized        update  replace the specified CSIStorageCapacity       HTTP Request  PUT  apis storage k8s io v1 namespaces  namespace  csistoragecapacities  name        Parameters       name     in path    string  required    name of the CSIStorageCapacity       namespace     in path    string  required     a href    namespace  a        body     a href    CSIStorageCapacity  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    CSIStorageCapacity  a    OK  201   a href    CSIStorageCapacity  a    Created  401  Unauthorized        patch  partially update the specified CSIStorageCapacity       HTTP Request  PATCH  apis storage k8s io v1 namespaces  namespace  csistoragecapacities  name        Parameters       name     in path    string  required    name of the CSIStorageCapacity       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    CSIStorageCapacity  a    OK  201   a href    CSIStorageCapacity  a    Created  401  Unauthorized        delete  delete a CSIStorageCapacity       HTTP Request  DELETE  apis storage k8s io v1 namespaces  namespace  csistoragecapacities  name        Parameters       name     in path    string  required    name of the CSIStorageCapacity       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    Status  a    OK  202   a href    Status  a    Accepted  401  Unauthorized        deletecollection  delete collection of CSIStorageCapacity       HTTP Request  DELETE  apis storage k8s io v1 namespaces  namespace  csistoragecapacities       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized


kubernetes reference apiVersion storage k8s io v1beta1 kind VolumeAttributesClass import k8s io api storage v1beta1 contenttype apireference VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver title VolumeAttributesClass v1beta1 apimetadata weight 12 autogenerated true

Answer:
---
api_metadata:
  apiVersion: "storage.k8s.io/v1beta1"
  import: "k8s.io/api/storage/v1beta1"
  kind: "VolumeAttributesClass"
content_type: "api_reference"
description: "VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver."
title: "VolumeAttributesClass v1beta1"
weight: 12
auto_generated: true
---

`apiVersion: storage.k8s.io/v1beta1`

`import "k8s.io/api/storage/v1beta1"`

## VolumeAttributesClass {#VolumeAttributesClass}

VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver. The class can be specified during dynamic provisioning of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.

- **apiVersion**: storage.k8s.io/v1beta1

- **kind**: VolumeAttributesClass

- **metadata** (ObjectMeta)

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **driverName** (string), required

  Name of the CSI driver This field is immutable.

- **parameters** (map[string]string)

  parameters hold volume attributes defined by the CSI driver. These values are opaque to the Kubernetes and are passed directly to the CSI driver. The underlying storage provider supports changing these attributes on an existing volume, however the parameters field itself is immutable. To invoke a volume update, a new VolumeAttributesClass should be created with new parameters, and the PersistentVolumeClaim should be updated to reference the new VolumeAttributesClass.

  This field is required and must contain at least one key/value pair. The keys cannot be empty, and the maximum number of parameters is 512, with a cumulative max size of 256K. If the CSI driver rejects invalid parameters, the target PersistentVolumeClaim will be set to an "Infeasible" state in the modifyVolumeStatus field.

## VolumeAttributesClassList {#VolumeAttributesClassList}

VolumeAttributesClassList is a collection of VolumeAttributesClass objects.

- **apiVersion**: storage.k8s.io/v1beta1

- **kind**: VolumeAttributesClassList

- **metadata** (ListMeta)

  Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **items** ([]VolumeAttributesClass), required

  items is the list of VolumeAttributesClass objects.

## Operations {#Operations}

### `get` read the specified VolumeAttributesClass

#### HTTP Request

GET /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the VolumeAttributesClass

- **pretty** (*in query*): string

  pretty

#### Response

200 (VolumeAttributesClass): OK

401: Unauthorized

### `list` list or watch objects of kind VolumeAttributesClass

#### HTTP Request

GET /apis/storage.k8s.io/v1beta1/volumeattributesclasses

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (VolumeAttributesClassList): OK

401: Unauthorized

### `create` create a VolumeAttributesClass

#### HTTP Request

POST /apis/storage.k8s.io/v1beta1/volumeattributesclasses

#### Parameters

- **body**: VolumeAttributesClass, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (VolumeAttributesClass): OK

201 (VolumeAttributesClass): Created

202 (VolumeAttributesClass): Accepted

401: Unauthorized

### `update` replace the specified VolumeAttributesClass

#### HTTP Request

PUT /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the VolumeAttributesClass

- **body**: VolumeAttributesClass, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (VolumeAttributesClass): OK

201 (VolumeAttributesClass): Created

401: Unauthorized

### `patch` partially update the specified VolumeAttributesClass

#### HTTP Request

PATCH /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the VolumeAttributesClass

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (VolumeAttributesClass): OK

201 (VolumeAttributesClass): Created

401: Unauthorized

### `delete` delete a VolumeAttributesClass

#### HTTP Request

DELETE /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the VolumeAttributesClass

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (VolumeAttributesClass): OK

202 (VolumeAttributesClass): Accepted

401: Unauthorized

### `deletecollection` delete collection of VolumeAttributesClass

#### HTTP Request

DELETE /apis/storage.k8s.io/v1beta1/volumeattributesclasses

#### Parameters

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   storage k8s io v1beta1    import   k8s io api storage v1beta1    kind   VolumeAttributesClass  content type   api reference  description   VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver   title   VolumeAttributesClass v1beta1  weight  12 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  storage k8s io v1beta1    import  k8s io api storage v1beta1        VolumeAttributesClass   VolumeAttributesClass   VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver  The class can be specified during dynamic provisioning of PersistentVolumeClaims  and changed in the PersistentVolumeClaim spec after provisioning    hr       apiVersion    storage k8s io v1beta1       kind    VolumeAttributesClass       metadata     a href    ObjectMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      driverName    string   required    Name of the CSI driver This field is immutable       parameters    map string string     parameters hold volume attributes defined by the CSI driver  These values are opaque to the Kubernetes and are passed directly to the CSI driver  The underlying storage provider supports changing these attributes on an existing volume  however the parameters field itself is immutable  To invoke a volume update  a new VolumeAttributesClass should be created with new parameters  and the PersistentVolumeClaim should be updated to reference the new VolumeAttributesClass       This field is required and must contain at least one key value pair  The keys cannot be empty  and the maximum number of parameters is 512  with a cumulative max size of 256K  If the CSI driver rejects invalid parameters  the target PersistentVolumeClaim will be set to an  Infeasible  state in the modifyVolumeStatus field          VolumeAttributesClassList   VolumeAttributesClassList   VolumeAttributesClassList is a collection of VolumeAttributesClass objects    hr       apiVersion    storage k8s io v1beta1       kind    VolumeAttributesClassList       metadata     a href    ListMeta  a      Standard list metadata More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      items       a href    VolumeAttributesClass  a    required    items is the list of VolumeAttributesClass objects          Operations   Operations      hr             get  read the specified VolumeAttributesClass       HTTP Request  GET  apis storage k8s io v1beta1 volumeattributesclasses  name        Parameters       name     in path    string  required    name of the VolumeAttributesClass       pretty     in query    string     a href    pretty  a          Response   200   a href    VolumeAttributesClass  a    OK  401  Unauthorized        list  list or watch objects of kind VolumeAttributesClass       HTTP Request  GET  apis storage k8s io v1beta1 volumeattributesclasses       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    VolumeAttributesClassList  a    OK  401  Unauthorized        create  create a VolumeAttributesClass       HTTP Request  POST  apis storage k8s io v1beta1 volumeattributesclasses       Parameters       body     a href    VolumeAttributesClass  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    VolumeAttributesClass  a    OK  201   a href    VolumeAttributesClass  a    Created  202   a href    VolumeAttributesClass  a    Accepted  401  Unauthorized        update  replace the specified VolumeAttributesClass       HTTP Request  PUT  apis storage k8s io v1beta1 volumeattributesclasses  name        Parameters       name     in path    string  required    name of the VolumeAttributesClass       body     a href    VolumeAttributesClass  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    VolumeAttributesClass  a    OK  201   a href    VolumeAttributesClass  a    Created  401  Unauthorized        patch  partially update the specified VolumeAttributesClass       HTTP Request  PATCH  apis storage k8s io v1beta1 volumeattributesclasses  name        Parameters       name     in path    string  required    name of the VolumeAttributesClass       body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    VolumeAttributesClass  a    OK  201   a href    VolumeAttributesClass  a    Created  401  Unauthorized        delete  delete a VolumeAttributesClass       HTTP Request  DELETE  apis storage k8s io v1beta1 volumeattributesclasses  name        Parameters       name     in path    string  required    name of the VolumeAttributesClass       body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    VolumeAttributesClass  a    OK  202   a href    VolumeAttributesClass  a    Accepted  401  Unauthorized        deletecollection  delete collection of VolumeAttributesClass       HTTP Request  DELETE  apis storage k8s io v1beta1 volumeattributesclasses       Parameters       body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized