Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BlockVolumeReplica

An asynchronous replica of a block volume that can then be used to create a new block volume or recover a block volume. For more information, see Overview of Cross-Region Volume Replication 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.

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

Properties

availabilityDomain

availabilityDomain: string

The availability domain of the block volume replica.

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

blockVolumeId

blockVolumeId: string

The OCID of the source block volume.

compartmentId

compartmentId: string

The OCID of the compartment that contains the block volume replica.

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 block volume replica's Oracle ID (OCID).

lifecycleState

lifecycleState: LifecycleState

The current state of a block volume replica.

sizeInGBs

sizeInGBs: number

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

timeCreated

timeCreated: Date

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

timeLastSynced

timeLastSynced: Date

The date and time the block volume replica was last synced from the source block volume. Format defined by RFC3339.

Optional totalDataTransferredInGBs

totalDataTransferredInGBs: undefined | number

The total size of the data transferred from the source block volume to the block volume replica, in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional volumeGroupReplicaId

volumeGroupReplicaId: undefined | string

The OCID of the volume group replica.

Functions

getDeserializedJsonObj

getJsonObj