block_volume_replicas

Creates, updates, deletes, gets or lists a block_volume_replicas resource.

Overview

Name	block_volume_replicas
Type	Resource
Id	oci.block_storage.block_volume_replicas

Fields

The following fields are returned by SELECT queries:

get

The block volume replica's information has been retrieved.

Name	Datatype	Description
id	string	The block volume replica's Oracle ID (OCID).
availabilityDomain	string	The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
blockVolumeId	string	The OCID of the source block volume.
compartmentId	string	The OCID of the compartment that contains the block volume replica.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleState	string	The current state of a block volume replica. (PROVISIONING, AVAILABLE, ACTIVATING, TERMINATING, TERMINATED, FAULTY)
sizeInGBs	integer (int64)	The size of the source block volume, in GBs.
timeCreated	string (date-time)	The date and time the block volume replica was created. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
timeLastSynced	string (date-time)	The date and time the block volume replica was last synced from the source block volume. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
totalDataTransferredInGBs	integer (int64)	The total size of the data transferred from the source block volume to the block volume replica, in GBs.
volumeGroupReplicaId	string	The OCID of the volume group replica.

list

An asynchronous replica of a block volume that can then be used to create<br />a new block volume or recover a block volume. For more information, see [Overview<br />of Cross-Region Volume Replication](/iaas/Content/Block/Concepts/volumereplication.htm)<br />To use any of the API operations, you must be authorized in an IAM policy.<br />If you're not authorized, talk to an administrator. If you're an administrator<br />who needs to write policies to give users access, see [Getting Started with<br />Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).<br /><br />Warning: Oracle recommends that you avoid using any confidential information when you<br />supply string values using the API.<br />

Name	Datatype	Description
id	string	The block volume replica's Oracle ID (OCID).
availabilityDomain	string	The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
blockVolumeId	string	The OCID of the source block volume.
compartmentId	string	The OCID of the compartment that contains the block volume replica.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleState	string	The current state of a block volume replica. (PROVISIONING, AVAILABLE, ACTIVATING, TERMINATING, TERMINATED, FAULTY)
sizeInGBs	integer (int64)	The size of the source block volume, in GBs.
timeCreated	string (date-time)	The date and time the block volume replica was created. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
timeLastSynced	string (date-time)	The date and time the block volume replica was last synced from the source block volume. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
totalDataTransferredInGBs	integer (int64)	The total size of the data transferred from the source block volume to the block volume replica, in GBs.
volumeGroupReplicaId	string	The OCID of the volume group replica.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	blockVolumeReplicaId, region		Gets information for the specified block volume replica.
list	select	availabilityDomain, compartmentId, region	limit, page, displayName, sortBy, sortOrder, lifecycleState	Lists the block volume replicas in the specified compartment and availability domain.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
availabilityDomain	string	The name of the availability domain. Example: Uocm:PHX-AD-1
blockVolumeReplicaId	string	The OCID of the block volume replica.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
displayName	string	A filter to return only resources that match the given display name exactly.
lifecycleState	string	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBy	string	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples

get

Gets information for the specified block volume replica.

SELECT
id,
availabilityDomain,
blockVolumeId,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
sizeInGBs,
timeCreated,
timeLastSynced,
totalDataTransferredInGBs,
volumeGroupReplicaId
FROM oci.block_storage.block_volume_replicas
WHERE blockVolumeReplicaId = '{{ blockVolumeReplicaId }}' -- required
AND region = '{{ region }}' -- required
;

list

Lists the block volume replicas in the specified compartment and availability domain.<br />

SELECT
id,
availabilityDomain,
blockVolumeId,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
sizeInGBs,
timeCreated,
timeLastSynced,
totalDataTransferredInGBs,
volumeGroupReplicaId
FROM oci.block_storage.block_volume_replicas
WHERE availabilityDomain = '{{ availabilityDomain }}' -- required
AND compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND displayName = '{{ displayName }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
;