Jump to

• Request
• Response

GetInstancePoolInstance

get

/20160918/instancePools/{instance_pool_id}/instances/{instance_id}

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

Request

Supported Media Types

• application/json

Path Parameters

• instanceId(required): string
  The OCID of the instance.
• instancePoolId(required): string
  The OCID of the instance pool.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The instance 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.

Body ()

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.
• 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

{
    "description":"Information about an instance that belongs to an instance pool.",
    "properties":{
        "id":{
            "description":"The OCID of the instance.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "instancePoolId":{
            "description":"The OCID of the instance pool.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "availabilityDomain":{
            "description":"The availability domain the instance is running in.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The attachment state of the instance in relation to the instance pool.",
            "enum":[
                "ATTACHING",
                "ACTIVE",
                "DETACHING"
            ],
            "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 configuration 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 the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "state":{
            "description":"The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.",
            "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.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstancePoolInstanceLoadBalancerBackend"
            }
        }
    },
    "required":[
        "id",
        "instancePoolId",
        "availabilityDomain",
        "lifecycleState",
        "compartmentId",
        "instanceConfigurationId",
        "region",
        "shape",
        "state",
        "timeCreated"
    ],
    "type":"object"
}

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.

{
    "description":"The load balancer backends that are configured for the 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"
}

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.

Body ()

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

429 Response

Too Many Requests

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.

Body ()

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top