Make a GET request to this resource to retrieve the list of instances.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of instances found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more instance records.

Results

Each instance data structure includes the following fields:

• id: Database ID for this instance. (integer)
• type: Data type for this instance. (choice)
• url: URL for this instance. (string)
• related: Data structure with URLs of related resources. (object)
• uuid: (string)
• hostname: (string)
• created: Timestamp when this instance was created. (datetime)
• modified: Timestamp when this instance was last modified. (datetime)
• last_seen: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)
• last_health_check: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)
• errors: Any error details from the last health check. (string)
• capacity_adjustment: (decimal)
• version: (string)
• capacity: (integer)
• consumed_capacity: (field)
• percent_capacity_remaining: (field)
• jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)
• jobs_total: Count of all jobs that target this instance (integer)
• cpu: (integer)
• memory: Total system memory of this instance in bytes. (integer)
• cpu_capacity: (integer)
• mem_capacity: (integer)
• enabled: (boolean)
• managed_by_policy: (boolean)
• node_type: (choice)
  • control: Control plane node
  • execution: Execution plane node
  • hybrid: Controller and execution
  • hop: Message-passing node, no execution capability

Sorting

To specify that instances are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Oracle Linux Automation Manaer) Search across related fields:

?related__search=findme