instance_pool_instances

Creates, updates, deletes, gets or lists an instance_pool_instances resource.

Overview

Name	instance_pool_instances
Type	Resource
Id	oci.compute.instance_pool_instances

Fields

The following fields are returned by SELECT queries:

get

The instance was retrieved.

Name	Datatype	Description
id	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance.
availabilityDomain	string	The availability domain the instance is running in.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the instance.
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
faultDomain	string	The fault domain the instance is running in.
instanceConfigurationId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration used to create the instance.
instancePoolId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.
lifecycleState	string	The attachment state of the instance in relation to the instance pool. (ATTACHING, ACTIVE, DETACHING, TERMINATION_AWAIT, TERMINATION_PROCEED)
loadBalancerBackends	array	The load balancer backends that are configured for the instance.
region	string	The region that contains the availability 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.
state	string	The lifecycle state of the instance. Refer to lifecycleState in the [Instance](#/en/iaas/latest/Instance) resource.
timeCreated	string (date-time)	The date and time the instance pool instance was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

list

Condensed instance data when listing instances in an instance pool.

Name	Datatype	Description
id	string	The OCID of the instance.
availabilityDomain	string	The availability domain the instance is running in.
compartmentId	string	The OCID of the compartment that contains the instance.
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
faultDomain	string	The fault domain the instance is running in.
instanceConfigurationId	string	The OCID of the instance confgiuration used to create the instance.
loadBalancerBackends	array	The load balancer backends that are configured for the instance pool instance.
region	string	The region that contains the availability domain the instance is running in.
shape	string	The shape of an 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 [ListShapes](#/en/iaas/latest/Shape/ListShapes).
state	string	The current state of the instance pool instance.
timeCreated	string (date-time)	The date and time the instance pool 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
get	select	instancePoolId, instanceId, region		Gets information about an instance that belongs to an instance pool.
list	select	compartmentId, instancePoolId, region	displayName, limit, page, sortBy, sortOrder	List the instances in the specified instance pool.

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.
instanceId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance.
instancePoolId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.
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)
displayName	string	A filter to return only resources that match the given display name exactly.
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
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

get

Gets information about an instance that belongs to an instance pool.

SELECT
id,
availabilityDomain,
compartmentId,
displayName,
faultDomain,
instanceConfigurationId,
instancePoolId,
lifecycleState,
loadBalancerBackends,
region,
shape,
state,
timeCreated
FROM oci.compute.instance_pool_instances
WHERE instancePoolId = '{{ instancePoolId }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND region = '{{ region }}' -- required
;

list

List the instances in the specified instance pool.

SELECT
id,
availabilityDomain,
compartmentId,
displayName,
faultDomain,
instanceConfigurationId,
loadBalancerBackends,
region,
shape,
state,
timeCreated
FROM oci.compute.instance_pool_instances
WHERE compartmentId = '{{ compartmentId }}' -- required
AND instancePoolId = '{{ instancePoolId }}' -- required
AND region = '{{ region }}' -- required
AND displayName = '{{ displayName }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;