Skip to main content

compute_clusters

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

Overview​

Namecompute_clusters
TypeResource
Idoci.compute.compute_clusters

Fields​

The following fields are returned by SELECT queries:

The compute cluster was retrieved.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.
availabilityDomainstringThe availability domain the compute cluster is running in. Example: Uocm:PHX-AD-1
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute cluster.
definedTagsobjectDefined 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"}}
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTagsobjectFree-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"}
lifecycleStatestringThe current state of the compute cluster. (ACTIVE, DELETED)
timeCreatedstring (date-time)The date and time the compute cluster was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcomputeClusterId, regionopc-request-idGets information about a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm)<br />is a remote direct memory access (RDMA) network group.<br />
listselectcompartmentId, regionavailabilityDomain, displayName, limit, page, sortBy, sortOrder, opc-request-idLists the compute clusters in the specified compartment.<br />A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.<br />
createinsertregion, availabilityDomain, compartmentIdopc-retry-token, opc-request-idCreates an empty [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster<br />is a remote direct memory access (RDMA) network group.<br /><br />After the compute cluster is created, you can use the compute cluster's OCID with the<br />[LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) operation to create instances in the compute cluster.<br />The instances must be created in the same compartment and availability domain as the cluster.<br /><br />Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group.<br /><br />If you want predictable capacity for a specific number of identical instances that are managed as a group,<br />create a cluster network that uses instance pools by using the<br />[CreateClusterNetwork](#/en/iaas/latest/ClusterNetwork/CreateClusterNetwork) operation.<br />
updateupdatecomputeClusterId, regionopc-request-id, opc-retry-token, if-matchUpdates a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a<br />remote direct memory access (RDMA) network group.<br /><br />To create instances within a compute cluster, use the [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance)<br />operation.<br /><br />To delete instances from a compute cluster, use the [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance)<br />operation.<br />
deletedeletecomputeClusterId, regionopc-request-id, if-matchDeletes a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a<br />remote direct memory access (RDMA) network group.<br /><br />Before you delete a compute cluster, first delete all instances in the cluster by using<br />the [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance) operation.<br />
change_compartmentexeccomputeClusterId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a compute cluster into a different compartment within the same tenancy.<br />A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.<br /><br />For information about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<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.

NameDatatypeDescription
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
computeClusterIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.
regionstringOCI 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)
availabilityDomainstringThe name of the availability domain. Example: Uocm:PHX-AD-1
displayNamestringA filter to return only resources that match the given display name exactly.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
limitintegerFor 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
opc-request-idstringUnique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringFor 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).
sortBystringThe 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.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples​

Gets information about a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm)<br />is a remote direct memory access (RDMA) network group.<br />

SELECT
id,
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
timeCreated
FROM oci.compute.compute_clusters
WHERE computeClusterId = '{{ computeClusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates an empty [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster<br />is a remote direct memory access (RDMA) network group.<br /><br />After the compute cluster is created, you can use the compute cluster's OCID with the<br />[LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) operation to create instances in the compute cluster.<br />The instances must be created in the same compartment and availability domain as the cluster.<br /><br />Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group.<br /><br />If you want predictable capacity for a specific number of identical instances that are managed as a group,<br />create a cluster network that uses instance pools by using the<br />[CreateClusterNetwork](#/en/iaas/latest/ClusterNetwork/CreateClusterNetwork) operation.<br />

INSERT INTO oci.compute.compute_clusters (
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ availabilityDomain }}' /* required */,
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
timeCreated
;

UPDATE examples​

Updates a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a<br />remote direct memory access (RDMA) network group.<br /><br />To create instances within a compute cluster, use the [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance)<br />operation.<br /><br />To delete instances from a compute cluster, use the [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance)<br />operation.<br />

UPDATE oci.compute.compute_clusters
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
computeClusterId = '{{ computeClusterId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND opc-retry-token = '{{ opc-retry-token}}'
AND if-match = '{{ if-match}}'
RETURNING
id,
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
timeCreated;

DELETE examples​

Deletes a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a<br />remote direct memory access (RDMA) network group.<br /><br />Before you delete a compute cluster, first delete all instances in the cluster by using<br />the [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance) operation.<br />

DELETE FROM oci.compute.compute_clusters
WHERE computeClusterId = '{{ computeClusterId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;

Lifecycle Methods​

Moves a compute cluster into a different compartment within the same tenancy.<br />A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.<br /><br />For information about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

EXEC oci.compute.compute_clusters.change_compartment 
@computeClusterId='{{ computeClusterId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;