REST API for Oracle Private Cloud Appliance Compute Enclave

List Instance Pool Instances

get

/20160918/instancePools/{instance_pool_id}/instances

List the instances in the specified instance pool.

Request

Supported Media Types

application/json

Path Parameters

instancePoolId(required): string

The OCID of the instance pool.

Query Parameters

compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment.
displayName: string

Minimum Length: 1

Maximum Length: 255

A filter to return only resources that match the entire display name given.
limit: integer

Minimum Value: 1

Maximum Value: 1000

For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

Default Value: 100
page: string

Minimum Length: 1

Maximum Length: 512

For list pagination. The value of the opc-next-page response header from the previous List call.

Default Value: 0
sortBy: string

The optional field to sort the results by.

Allowed Values: [ "TIMECREATED", "NAME" ]
sortOrder: string

The sort order to use, either ascending (ASC) or descending (DESC).

Default Value: ASC

Allowed Values: [ "ASC", "DESC" ]

Response

Supported Media Types

application/json

200 Response

The list is being retrieved

Headers

opc-next-page: string

For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
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 : schema

Type: array

Show Source

Array of: object InstanceSummary

Condensed instance data when listing instances in an instance pool.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstanceSummary"
    }
}

Nested Schema : InstanceSummary

Type: object

Condensed instance data when listing instances in 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 confgiuration used to create the instance.
loadBalancerBackends: array loadBalancerBackends

The load balancer backends that are configured for the instance pool 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: string

Minimum Length: 1

Maximum Length: 255

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.
state(required): string

Minimum Length: 1

Maximum Length: 255

The current state of the instance pool instance.
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

{
    "description":"Condensed instance data when listing instances in an instance pool.",
    "properties":{
        "id":{
            "description":"The OCID of the instance.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "availabilityDomain":{
            "description":"The availability domain the instance is running in.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the instance.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "faultDomain":{
            "description":"The fault domain the instance is running in.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "instanceConfigurationId":{
            "description":"The OCID of the instance confgiuration used to create the instance.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "region":{
            "description":"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.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "shape":{
            "description":"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.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "state":{
            "description":"The current state of the instance pool instance.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "timeCreated":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "loadBalancerBackends":{
            "description":"The load balancer backends that are configured for the instance pool instance.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstancePoolInstanceLoadBalancerBackend"
            }
        },
        "rackId":{
            "description":"The ID of the rack where an instance is placed.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        }
    },
    "required":[
        "id",
        "availabilityDomain",
        "compartmentId",
        "instanceConfigurationId",
        "region",
        "state",
        "timeCreated"
    ],
    "type":"object"
}

Nested Schema : loadBalancerBackends

Type: array

The load balancer backends that are configured for the instance pool instance.

Show Source

Array of: object InstancePoolInstanceLoadBalancerBackend

Represents the load balancer Backend that is configured for an instance pool instance.

{
    "description":"The load balancer backends that are configured for the instance pool instance.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstancePoolInstanceLoadBalancerBackend"
    }
}

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.

{
    "description":"Represents the load balancer Backend that is configured for an instance pool instance.",
    "properties":{
        "loadBalancerId":{
            "type":"string",
            "description":"The OCID of the load balancer attached to the instance pool.",
            "minLength":1,
            "maxLength":255
        },
        "backendSetName":{
            "type":"string",
            "description":"The name of the backend set on the load balancer.",
            "minLength":1,
            "maxLength":255
        },
        "backendName":{
            "type":"string",
            "description":"The name of the backend in the backend set.",
            "minLength":1,
            "maxLength":255
        },
        "backendHealthStatus":{
            "type":"string",
            "description":"The health of the backend as observed by the load balancer.",
            "enum":[
                "OK",
                "WARNING",
                "CRITICAL",
                "UNKNOWN"
            ]
        }
    },
    "required":[
        "loadBalancerId",
        "backendSetName",
        "backendName",
        "backendHealthStatus"
    ],
    "type":"object"
}

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}