volume_group_replicas

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

Overview

Name	volume_group_replicas
Type	Resource
Id	oci.block_storage.volume_group_replicas

Fields

The following fields are returned by SELECT queries:

get

The volume group replica was retrieved.

Name	Datatype	Description
id	string	The OCID for the volume group replica.
availabilityDomain	string	The availability domain of the volume group replica.
compartmentId	string	The OCID of the compartment that contains the volume group 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 volume group. (PROVISIONING, AVAILABLE, ACTIVATING, TERMINATING, TERMINATED, FAULTY)
memberReplicas	array	Volume replicas within this volume group replica.
sizeInGBs	integer (int64)	The aggregate size of the volume group replica in GBs.
timeCreated	string (date-time)	The date and time the volume group replica was created. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
timeLastSynced	string (date-time)	The date and time the volume group replica was last synced from the source volume group. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
volumeGroupId	string	The OCID of the source volume group.

list

An asynchronous replica of a volume group that can then be used to create a new volume group<br />or recover a volume group. For more information, see [Volume Group Replication](/iaas/Content/Block/Concepts/volumegroupreplication.htm).<br /><br />To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,<br />talk to an administrator. If you're an administrator who needs to write policies to give users access, see<br />[Getting Started with 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 OCID for the volume group replica.
availabilityDomain	string	The availability domain of the volume group replica.
compartmentId	string	The OCID of the compartment that contains the volume group 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 volume group. (PROVISIONING, AVAILABLE, ACTIVATING, TERMINATING, TERMINATED, FAULTY)
memberReplicas	array	Volume replicas within this volume group replica.
sizeInGBs	integer (int64)	The aggregate size of the volume group replica in GBs.
timeCreated	string (date-time)	The date and time the volume group replica was created. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
timeLastSynced	string (date-time)	The date and time the volume group replica was last synced from the source volume group. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
volumeGroupId	string	The OCID of the source volume group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	volumeGroupReplicaId, region		Gets information for the specified volume group replica.
list	select	availabilityDomain, compartmentId, region	limit, page, displayName, sortBy, sortOrder, lifecycleState	Lists the volume group replicas in the specified compartment. You can filter the results by volume group.<br />For more information, see [Volume Group Replication](/iaas/Content/Block/Concepts/volumegroupreplication.htm).<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
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)
volumeGroupReplicaId	string	The OCID of the volume replica group.
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 volume group replica.

SELECT
id,
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
memberReplicas,
sizeInGBs,
timeCreated,
timeLastSynced,
volumeGroupId
FROM oci.block_storage.volume_group_replicas
WHERE volumeGroupReplicaId = '{{ volumeGroupReplicaId }}' -- required
AND region = '{{ region }}' -- required
;

list

Lists the volume group replicas in the specified compartment. You can filter the results by volume group.<br />For more information, see [Volume Group Replication](/iaas/Content/Block/Concepts/volumegroupreplication.htm).<br />

SELECT
id,
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
memberReplicas,
sizeInGBs,
timeCreated,
timeLastSynced,
volumeGroupId
FROM oci.block_storage.volume_group_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 }}'
;