compute_capacity_reservation_instances

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

Overview

Name	compute_capacity_reservation_instances
Type	Resource
Id	oci.compute.compute_capacity_reservation_instances

Fields

The following fields are returned by SELECT queries:

list

Condensed instance data when listing instances in a compute capacity reservation.

Name	Datatype	Description
id	string	The OCID of the instance.
availabilityDomain	string	The availability domain the instance is running in.
clusterPlacementGroupId	string	The OCID of the cluster placement group of the instance.
compartmentId	string	The OCID of the compartment that contains the instance.
faultDomain	string	The fault domain the instance is running in.
shape	string	The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. You can enumerate all available shapes by calling [ListComputeCapacityReservationInstanceShapes](#/en/iaas/latest/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes).
shapeConfig	object	The shape configuration requested when launching instances in a compute capacity reservation. If the parameter is provided, the reservation is created with the resources that you specify. If some properties are missing or the parameter is not provided, the reservation is created with the default configuration values for the shape that you specify. Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned. For more information about customizing the resources that are allocated to flexible shapes, see [Flexible Shapes](/iaas/Content/Compute/References/computeshapes.htm#flexible).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	capacityReservationId, region	availabilityDomain, compartmentId, opc-request-id, limit, page, sortBy, sortOrder	Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.<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
capacityReservationId	string	The OCID of the compute capacity reservation.
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)
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.
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
opc-request-id	string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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

list

Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.<br />

SELECT
id,
availabilityDomain,
clusterPlacementGroupId,
compartmentId,
faultDomain,
shape,
shapeConfig
FROM oci.compute.compute_capacity_reservation_instances
WHERE capacityReservationId = '{{ capacityReservationId }}' -- required
AND region = '{{ region }}' -- required
AND availabilityDomain = '{{ availabilityDomain }}'
AND compartmentId = '{{ compartmentId }}'
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;