Skip to main content

compute_capacity_topologies

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

Overview​

Namecompute_capacity_topologies
TypeResource
Idoci.compute.compute_capacity_topologies

Fields​

The following fields are returned by SELECT queries:

The information of the compute capacity topology was retrieved.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
availabilityDomainstringThe availability domain of the compute capacity topology. Example: Uocm:US-CHICAGO-1-AD-2
capacitySourceobjectA capacity source of bare metal hosts.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute capacity topology.
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 capacity topology. (ACTIVE, CREATING, UPDATING, DELETED, DELETING)
timeCreatedstring (date-time)The date and time that the compute capacity topology was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
timeUpdatedstring (date-time)The date and time that the compute capacity topology was updated, 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
getselectcomputeCapacityTopologyId, regionopc-request-idGets information about the specified compute capacity topology.
listselectcompartmentId, regionavailabilityDomain, displayName, limit, page, opc-request-id, sortBy, sortOrderLists the compute capacity topologies in the specified compartment. You can filter the list by a compute<br />capacity topology display name.<br />
createinsertregion, availabilityDomain, capacitySource, compartmentIdopc-request-id, opc-retry-tokenCreates a new compute capacity topology in the specified compartment and availability domain.<br /><br />Compute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch<br />instances on your bare metal hosts with targeted network locations.<br /><br />Compute capacity topologies report the health status of your bare metal hosts.<br />
updateupdatecomputeCapacityTopologyId, regionif-match, opc-request-idUpdates the specified compute capacity topology. Fields that are not provided in the request will not be updated.<br />
deletedeletecomputeCapacityTopologyId, regionif-match, opc-request-idDeletes the specified compute capacity topology.
change_compartmentexeccomputeCapacityTopologyId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a compute capacity topology into a different compartment. For information about moving resources between<br />compartments, see [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.
computeCapacityTopologyIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
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 the specified compute capacity topology.

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

INSERT examples​

Creates a new compute capacity topology in the specified compartment and availability domain.<br /><br />Compute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch<br />instances on your bare metal hosts with targeted network locations.<br /><br />Compute capacity topologies report the health status of your bare metal hosts.<br />

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

UPDATE examples​

Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated.<br />

UPDATE oci.compute.compute_capacity_topologies
SET 
capacitySource = '{{ capacitySource }}',
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
computeCapacityTopologyId = '{{ computeCapacityTopologyId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}';

DELETE examples​

Deletes the specified compute capacity topology.

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

Lifecycle Methods​

Moves a compute capacity topology into a different compartment. For information about moving resources between<br />compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

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