Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Volume

A detachable block volume device that allows you to dynamically expand the storage capacity of an instance. For more information, see Overview of Cloud Volume Storage.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

Optional autoTunedVpusPerGB

autoTunedVpusPerGB: undefined | number

The number of Volume Performance Units per GB that this volume is effectively tuned to. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional autotunePolicies

autotunePolicies: Array<AutotunePolicy>

The list of autotune policies enabled for this volume.

availabilityDomain

availabilityDomain: string

The availability domain of the volume.

Example: {@code Uocm:PHX-AD-1}

Optional blockVolumeReplicas

blockVolumeReplicas: Array<BlockVolumeReplicaInfo>

The list of block volume replicas of this volume.

Optional clusterPlacementGroupId

clusterPlacementGroupId: undefined | string

The clusterPlacementGroup Id of the volume for volume placement.

compartmentId

compartmentId: string

The OCID of the compartment that contains the volume.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

displayName

displayName: string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the volume.

Optional isAutoTuneEnabled

isAutoTuneEnabled: undefined | false | true

Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the {@code DetachedVolumeAutotunePolicy} instead to enable the volume for detached autotune.

Optional isHydrated

isHydrated: undefined | false | true

Specifies whether the cloned volume's data has finished copying from the source volume or backup.

Optional kmsKeyId

kmsKeyId: undefined | string

The OCID of the Vault service key which is the master encryption key for the volume.

lifecycleState

lifecycleState: LifecycleState

The current state of a volume.

Optional sizeInGBs

sizeInGBs: undefined | number

The size of the volume in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

sizeInMBs

sizeInMBs: number

The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional sourceDetails

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

timeCreated

timeCreated: Date

The date and time the volume was created. Format defined by RFC3339.

Optional volumeGroupId

volumeGroupId: undefined | string

The OCID of the source volume group.

Optional vpusPerGB

vpusPerGB: undefined | number

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

Allowed values:

{@code 0}: Represents Lower Cost option.

{@code 10}: Represents Balanced option.

{@code 20}: Represents Higher Performance option.

{@code 30}-{@code 120}: Represents the Ultra High Performance option.

For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Volume): object

getJsonObj

  • getJsonObj(obj: Volume): object