Attach an Instance Pool Instance
post
/20160918/instancePools/{instance_pool_id}/instances
Attach an instance to an instance pool.
Request
Supported Media Types
- application/json
Path Parameters
-
instancePoolId(required): string
The OCID of the instance pool.
Header Parameters
-
opc-retry-token: string
Minimum Length:
1
Maximum Length:64
A 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).
Attach an instance to a pool
Root Schema : AttachInstancePoolInstanceDetails
Type:
object
An instance that is to be attached to an instance pool.
Show Source
-
instanceId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the instance.
Response
Supported Media Types
- application/json
201 Response
The instance is being attached to the pool.
Headers
-
etag: string
For optimistic concurrency control. See `if-match`.
-
location: string
Location of the resource.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
-
opc-work-request-id: string
The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request.
Root Schema : InstancePoolInstance
Type:
object
Information about an instance that belongs to an instance pool.
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain the instance is running in. -
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment that contains the instance. -
displayName:
string
Minimum Length:
1
Maximum Length:255
A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information. -
faultDomain:
string
Minimum Length:
1
Maximum Length:255
The fault domain the instance is running in. -
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the instance. -
instanceConfigurationId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the instance configuration used to create the instance. -
instancePoolId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the instance pool. -
lifecycleState(required):
string
Allowed Values:
[ "ATTACHING", "ACTIVE", "DETACHING" ]
The attachment state of the instance in relation to the instance pool. -
loadBalancerBackends:
array loadBalancerBackends
The load balancer backends that are configured for the instance.
-
rackId:
string
Minimum Length:
1
Maximum Length:255
The ID of the rack where an instance is placed. -
region(required):
string
Minimum Length:
1
Maximum Length:255
The region that contains the availability domain the instance is running in. Oracle Private Cloud Appliance has one region, named pca_name.domain (for example: mypca.example.com), and one availability domain, named AD-1. -
shape(required):
string
Minimum Length:
1
Maximum Length:255
The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. -
state(required):
string
Minimum Length:
1
Maximum Length:255
The lifecycle state of the instance. Refer to lifecycleState in the Instance resource. -
timeCreated(required):
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
Nested Schema : loadBalancerBackends
Type:
array
The load balancer backends that are configured for the instance.
Show Source
-
Array of:
object InstancePoolInstanceLoadBalancerBackend
Represents the load balancer Backend that is configured for an instance pool instance.
Nested Schema : InstancePoolInstanceLoadBalancerBackend
Type:
object
Represents the load balancer Backend that is configured for an instance pool instance.
Show Source
-
backendHealthStatus(required):
string
Allowed Values:
[ "OK", "WARNING", "CRITICAL", "UNKNOWN" ]
The health of the backend as observed by the load balancer. -
backendName(required):
string
Minimum Length:
1
Maximum Length:255
The name of the backend in the backend set. -
backendSetName(required):
string
Minimum Length:
1
Maximum Length:255
The name of the backend set on the load balancer. -
loadBalancerId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the load balancer attached to the instance pool.
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
409 Response
Conflict
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.