Skip to main content

compute_capacity_reservations

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

Overview​

Namecompute_capacity_reservations
TypeResource
Idoci.compute.compute_capacity_reservations

Fields​

The following fields are returned by SELECT queries:

The compute capacity reservation's information was retrieved.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity reservation.
availabilityDomainstringThe availability domain of the compute capacity reservation. Example: Uocm:PHX-AD-1
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the compute capacity reservation.
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"}
instanceReservationConfigsarrayThe capacity configurations for the capacity reservation. To use the reservation for the desired shape, specify the shape, count, and optionally the fault domain where you want this configuration.
isDefaultReservationbooleanWhether this capacity reservation is the default. For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).
lifecycleStatestringThe current state of the compute capacity reservation. (ACTIVE, CREATING, UPDATING, MOVING, DELETED, DELETING)
reservedInstanceCountinteger (int64)The number of instances for which capacity will be held with this compute capacity reservation. This number is the sum of the values of the reservedCount fields for all of the instance capacity configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation.
timeCreatedstring (date-time)The date and time the compute capacity reservation 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 the compute capacity reservation was updated, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
usedInstanceCountinteger (int64)The total number of instances currently consuming space in this compute capacity reservation. This number is the sum of the values of the usedCount fields for all of the instance capacity configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcapacityReservationId, regionopc-request-idGets information about the specified compute capacity reservation.
listselectcompartmentId, regionavailabilityDomain, lifecycleState, displayName, limit, page, opc-request-id, sortBy, sortOrderLists the compute capacity reservations that match the specified criteria and compartment.<br /><br />You can limit the list by specifying a compute capacity reservation display name<br />(the list will include all the identically-named compute capacity reservations in the compartment).<br />
createinsertregion, compartmentId, availabilityDomainopc-request-id, opc-retry-tokenCreates a new compute capacity reservation in the specified compartment and availability domain.<br />Compute capacity reservations let you reserve instances in a compartment.<br />When you launch an instance using this reservation, you are assured that you have enough space for your instance,<br />and you won't get out of capacity errors.<br />For more information, see [Reserved Capacity](/iaas/Content/Compute/Tasks/reserve-capacity.htm).<br />
updateupdatecapacityReservationId, regionif-match, opc-request-idUpdates the specified capacity reservation and its associated capacity configurations.<br />Fields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted.<br />Avoid entering confidential information.<br />
deletedeletecapacityReservationId, regionopc-request-id, if-matchDeletes the specified compute capacity reservation.
change_compartmentexeccapacityReservationId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a compute capacity reservation into a different compartment. For information about<br />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
capacityReservationIdstringThe OCID of the compute capacity reservation.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
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.
lifecycleStatestringA filter to only return resources that match the given lifecycle state.
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 reservation.

SELECT
id,
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
instanceReservationConfigs,
isDefaultReservation,
lifecycleState,
reservedInstanceCount,
timeCreated,
timeUpdated,
usedInstanceCount
FROM oci.compute.compute_capacity_reservations
WHERE capacityReservationId = '{{ capacityReservationId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a new compute capacity reservation in the specified compartment and availability domain.<br />Compute capacity reservations let you reserve instances in a compartment.<br />When you launch an instance using this reservation, you are assured that you have enough space for your instance,<br />and you won't get out of capacity errors.<br />For more information, see [Reserved Capacity](/iaas/Content/Compute/Tasks/reserve-capacity.htm).<br />

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

UPDATE examples​

Updates the specified capacity reservation and its associated capacity configurations.<br />Fields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted.<br />Avoid entering confidential information.<br />

UPDATE oci.compute.compute_capacity_reservations
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
instanceReservationConfigs = '{{ instanceReservationConfigs }}',
isDefaultReservation = {{ isDefaultReservation }}
WHERE 
capacityReservationId = '{{ capacityReservationId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}';

DELETE examples​

Deletes the specified compute capacity reservation.

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

Lifecycle Methods​

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

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