GetInstancePool
get
/20160918/instancePools/{instance_pool_id}
Get the specified instance pool.
Request
Supported Media Types
- application/json
Path Parameters
-
instancePoolId(required): string
The OCID of the instance pool.
Response
Supported Media Types
- application/json
200 Response
The instance pool was retrieved.
Headers
-
etag: string
For optimistic concurrency control. See if-match.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : InstancePool
Type:
objectAn instance pool is a set of instances that are managed as a group. For more information about instance pools and instance configurations, see "Working with Instance Configurations" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-configs.html#usr-instconfig-create) and "Working with Instance Pools" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-instance-pools).
Show Source
-
compartmentId(required):
string
Minimum Length:
1Maximum Length:255The OCID of the compartment containing the instance pool. -
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace.
-
displayName:
string
Minimum Length:
1Maximum Length:255A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information. -
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
-
id(required):
string
Minimum Length:
1Maximum Length:255The OCID of the instance pool. -
instanceConfigurationId(required):
string
Minimum Length:
1Maximum Length:255The OCID of the instance configuration associated with the instance pool. -
instanceDisplayNameFormatter:
string
Minimum Length:
1Maximum Length:255A user-friendly formatter for the instance pool's instance display names. Instance display names follow the format. The formatter does not retroactively change instance display names. Only future instance display names follow the format. -
instanceHostnameFormatter:
string
Minimum Length:
1Maximum Length:255A user-friendly formatter for the instance pool's instance hostnames. Instance hostnames follow the format. The formatter does not retroactively change instance hostnames. Only future instance hostnames follow the format -
lifecycleState(required):
string
Allowed Values:
[ "PROVISIONING", "SCALING", "STARTING", "STOPPING", "TERMINATING", "STOPPED", "TERMINATED", "RUNNING" ]The current state of the instance pool. -
loadBalancers:
array loadBalancers
The load balancers attached to the instance pool.
-
placementConfigurations(required):
array placementConfigurations
The placement configurations for the instance pool.
-
size(required):
integer
The number of instances that should be in the instance pool.
-
timeCreated(required):
string(date-time)
The date and time the instance pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
-
timeStateUpdated:
string(date-time)
The last date and time the instance pool state was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
Nested Schema : definedTags
Type:
objectAdditional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : freeformTags
Type:
objectAdditional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : loadBalancers
Type:
arrayThe load balancers attached to the instance pool.
Show Source
-
Array of:
object InstancePoolLoadBalancerAttachment
Represents a load balancer that is attached to an instance pool.
Nested Schema : placementConfigurations
Type:
arrayThe placement configurations for the instance pool.
Show Source
-
Array of:
object InstancePoolPlacementConfiguration
The location for where an instance pool will place instances.
Nested Schema : additionalProperties
Type:
objectAdditional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only the String type is supported.
Key-value pair representing a defined tag key and value, scoped to a namespace.
Nested Schema : additionalProperties
Type:
objectThe value of the tag. Only the String type is supported.
Nested Schema : InstancePoolLoadBalancerAttachment
Type:
objectRepresents a load balancer that is attached to an instance pool.
Show Source
-
backendSetName(required):
string
Minimum Length:
1Maximum Length:255The name of the backend set on the load balancer. -
id(required):
string
Minimum Length:
1Maximum Length:255The OCID of the load balancer attachment. -
instancePoolId(required):
string
Minimum Length:
1Maximum Length:255The OCID of the instance pool of the load balancer attachment. -
lifecycleState(required):
string
Allowed Values:
[ "ATTACHING", "ATTACHED", "DETACHING", "DETACHED" ]The status of the interaction between the instance pool and the load balancer. -
loadBalancerId(required):
string
Minimum Length:
1Maximum Length:255The OCID of the load balancer attached to the instance pool. -
port(required):
integer
Minimum Value:
0Maximum Value:65535The port value used for the backends. -
vnicSelection(required):
string
Minimum Length:
1Maximum Length:255Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.
Nested Schema : InstancePoolPlacementConfiguration
Type:
objectThe location for where an instance pool will place instances.
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1Maximum Length:255The availability domain to place instances. Example: AD-1 -
faultDomains:
array faultDomains
Unique Items Required:
trueThe fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3] -
primarySubnetId(required):
string
Minimum Length:
1Maximum Length:255The OCID of the primary subnet to place instances. -
secondaryVnicSubnets:
array secondaryVnicSubnets
Unique Items Required:
trueThe set of secondary VNIC data for instances in the pool.
Nested Schema : faultDomains
Type:
arrayUnique Items Required:
trueThe fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]
Show Source
Nested Schema : secondaryVnicSubnets
Type:
arrayUnique Items Required:
trueThe set of secondary VNIC data for instances in the pool.
Show Source
-
Array of:
object InstancePoolPlacementSecondaryVnicSubnet
The secondary VNIC object for the placement configuration for an instance pool.
Nested Schema : InstancePoolPlacementSecondaryVnicSubnet
Type:
objectThe secondary VNIC object for the placement configuration for an instance pool.
Show Source
-
displayName:
string
Minimum Length:
1Maximum Length:255The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC. -
subnetId(required):
string
Minimum Length:
1Maximum Length:255The subnet OCID for the secondary VNIC.
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
objectThe properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError -
message(required):
string
A human-readable error string.Example:
error validating payload
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
objectThe properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError -
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
objectThe properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError -
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
objectThe properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError -
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
objectThe properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError -
message(required):
string
A human-readable error string.Example:
error validating payload