Jump to

• Request
• Response

ListInstancePools

get

/20160918/instancePools

List the instance pools in the specified compartment.

Request

Supported Media Types

• application/json

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.
• lifecycleState: string
  A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
• 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: oracle.doceng.json.BetterJsonNull@2c07545f
• sortBy: string
  The optional field to sort the results by.

  Default Value: NAME

  Allowed Values: [ "ID", "NAME", "TIME_CREATED" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

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

Back to Top

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. Use this value as the page parameter to get the next page of items.
• 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 : schema

Type: array

Show Source

• Array of: object InstancePoolSummary
  Summary information for an instance pool.

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

Nested Schema : InstancePoolSummary

Type: object

Summary information for an instance pool.

Show Source

• availabilityDomains(required): array availabilityDomains
  Minimum Number of Items: 1

  The availability domains for the instance pool.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the instance pool.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace.
• 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.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-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: 1

  Maximum Length: 255

  The OCID of the instance pool.
• instanceConfigurationId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the instance configuration associated with the instance pool.
• lifecycleState(required): string
  Allowed Values: [ "PROVISIONING", "SCALING", "STARTING", "STOPPING", "TERMINATING", "STOPPED", "TERMINATED", "RUNNING" ]

  The current state of 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

{
    "description":"Summary information for an instance pool.",
    "properties":{
        "id":{
            "description":"The OCID of the instance pool.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment containing the instance pool.",
            "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"
        },
        "instanceConfigurationId":{
            "description":"The OCID of the instance configuration associated with the instance pool.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the instance pool.",
            "enum":[
                "PROVISIONING",
                "SCALING",
                "STARTING",
                "STOPPING",
                "TERMINATING",
                "STOPPED",
                "TERMINATED",
                "RUNNING"
            ],
            "type":"string"
        },
        "availabilityDomains":{
            "description":"The availability domains for the instance pool.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "minLength":"1",
            "maxLength":"255",
            "minItems":"1"
        },
        "size":{
            "description":"The number of instances that should be in the instance pool.",
            "type":"integer"
        },
        "timeCreated":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "timeStateUpdated":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        }
    },
    "required":[
        "id",
        "compartmentId",
        "instanceConfigurationId",
        "lifecycleState",
        "size",
        "timeCreated",
        "availabilityDomains"
    ],
    "type":"object"
}

Nested Schema : availabilityDomains

Type: array

Minimum Length: 1

Maximum Length: 255

Minimum Number of Items: 1

The availability domains for the instance pool.

Show Source

• Array of: string

{
    "description":"The availability domains for the instance pool.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "minLength":"1",
    "maxLength":"255",
    "minItems":"1"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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 : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

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.

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

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

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