Perform a Patch on a volumeset by name
Authorizations
Service account key can be used as API keys
Body
description
, tags
, spec
, gvc
The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this.
The guaranteed free space on the volume as a percentage of the volume's total size. ControlPlane will try to maintain at least that many percent free by scaling up the total size
When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor.
ext4
, xfs
, shared
The initial size in GB of volumes in this set.
general-purpose-ssd
, high-throughput-ssd
, shared
If true, a volume snapshot will be created immediately before deletion of any volume in this set
The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
A standard cron schedule expression used to determine when your job should execute.
For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
250
initialCapacity
, performanceClass
, storageClassSuffix
, fileSystemType
, snapshots
, autoscaling
The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this.
The guaranteed free space on the volume as a percentage of the volume's total size. ControlPlane will try to maintain at least that many percent free by scaling up the total size
When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor.
If true, a volume snapshot will be created immediately before deletion of any volume in this set
The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
A standard cron schedule expression used to determine when your job should execute.
maxCapacity
, minFreePercentage
, scalingFactor
The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this.
The guaranteed free space on the volume as a percentage of the volume's total size. ControlPlane will try to maintain at least that many percent free by scaling up the total size
When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor.
ext4
, xfs
, shared
The initial size in GB of volumes in this set.
general-purpose-ssd
, high-throughput-ssd
, shared
createFinalSnapshot
, retentionDuration
, schedule
If true, a volume snapshot will be created immediately before deletion of any volume in this set
The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
A standard cron schedule expression used to determine when your job should execute.
For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
Response
250
64
The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this.
The guaranteed free space on the volume as a percentage of the volume's total size. ControlPlane will try to maintain at least that many percent free by scaling up the total size
When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor.
ext4
, xfs
, shared
The initial size in GB of volumes in this set.
general-purpose-ssd
, high-throughput-ssd
, shared
If true, a volume snapshot will be created immediately before deletion of any volume in this set
The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
A standard cron schedule expression used to determine when your job should execute.
For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
The id of the cluster assigned to the gvc in this location.
The name of the location in which this volume was provisioned
The total bytes used in the volume.
The current capacity of the volume in GB
The name of the CSI driver used to provision and manage this volume
This number is used to order volumes within the volume set. It is used by Control Plane to link volumes with the workload replicas that use them.
creating
, unused
, unbound
, bound
, deleted
, repairing
The most recently used storageDeviceId. This is meant for use by Control Plane only
The id of the volume as provided by the underlying storage implementation. If this is blank, an actual storage device has not yet been created.
The date and time that the snapshot was created in the Control Plane API
The date and time on which this snapshot will be automatically deleted.
The id of the snapshot as provided by the underlying storage implementation.
A human-readable name for this snapshot.
The size of the snapshot in GB.