dedicated_vm_host_instances

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

Overview

Name	dedicated_vm_host_instances
Type	Resource
Id	oci.compute.dedicated_vm_host_instances

Fields

The following fields are returned by SELECT queries:

list

Condensed instance data when listing instances on a dedicated VM host.<br />

Name	Datatype	Description
availabilityDomain	string	The availability domain the virtual machine instance is running in. Example: Uocm:PHX-AD-1
compartmentId	string	The OCID of the compartment that contains the virtual machine instance.
instanceId	string	The OCID of the virtual machine instance.
isBurstable	boolean	Specifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If true, only Burstable VMs can be launched. If false, Burstable VMs cannot be launched.
isMemoryEncryptionEnabled	boolean	Specifies whether the VM instance is confidential.
shape	string	The shape of the VM instance.
timeCreated	string (date-time)	The date and time the virtual machine instance 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:

Name	Accessible by	Required Params	Optional Params	Description
list	select	compartmentId, dedicatedVmHostId, region	availabilityDomain, isMemoryEncryptionEnabled, limit, page, opc-request-id, sortBy, sortOrder	Returns the list of instances on the dedicated virtual machine hosts that match the specified 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
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
dedicatedVmHostId	string	The OCID of the dedicated VM host.
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
isMemoryEncryptionEnabled	boolean	A filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH.
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

Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.<br />

SELECT
availabilityDomain,
compartmentId,
instanceId,
isBurstable,
isMemoryEncryptionEnabled,
shape,
timeCreated
FROM oci.compute.dedicated_vm_host_instances
WHERE compartmentId = '{{ compartmentId }}' -- required
AND dedicatedVmHostId = '{{ dedicatedVmHostId }}' -- required
AND region = '{{ region }}' -- required
AND availabilityDomain = '{{ availabilityDomain }}'
AND isMemoryEncryptionEnabled = '{{ isMemoryEncryptionEnabled }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;