Oracle Linux Automation Manager CLI and API Reference Guide

Health Check Data

get

/api/v2/instances/{id}/health_check/

Health checks are used to obtain important data about an instance. Instance fields affected by the health check are shown in this view. Fundamentally, health checks require running code on the machine in question.

For instances with node_type of "control" or "hybrid", health checks are performed as part of a periodic task that runs in the background.
For instances with node_type of "execution", health checks are done by submitting a work unit through the receptor mesh.

If ran through the receptor mesh, the invoked command is:

ansible-runner worker --worker-info

For execution nodes, these checks are not performed on a regular basis. Health checks against functional nodes will be ran when the node is first discovered. Health checks against nodes with errors will be repeated at a reduced frequency.

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Query Parameters

page: integer

A page number within the paginated result set.
page_size: integer

Number of results to return per page.
search: string

A search term.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

count(required): integer
next: string(uri)
previous: string(uri)
results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/InstanceHealthCheck"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

Array of: object InstanceHealthCheck

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

Nested Schema : InstanceHealthCheck

Type: object

Show Source

capacity: integer

Title: Capacity

Read Only: true
cpu: string(decimal)

Title: Cpu

Read Only: true
cpu_capacity: integer

Title: Cpu capacity

Read Only: true
errors: string

Title: Errors

Read Only: true

Minimum Length: 1

Any error details from the last health check.
hostname: string

Title: Hostname

Read Only: true

Minimum Length: 1
ip_address: string

Title: Ip address

Read Only: true

Minimum Length: 1
last_health_check: string(date-time)

Title: Last health check

Read Only: true

Last time a health check was ran on this instance to refresh cpu, memory, and capacity.
mem_capacity: integer

Title: Mem capacity

Read Only: true
memory: integer

Title: Memory

Read Only: true

Total system memory of this instance in bytes.
uuid: string

Title: Uuid

Read Only: true

Minimum Length: 1
version: string

Title: Version

Read Only: true

Minimum Length: 1

{
    "properties":{
        "capacity":{
            "readOnly":true,
            "title":"Capacity",
            "type":"integer"
        },
        "cpu":{
            "format":"decimal",
            "readOnly":true,
            "title":"Cpu",
            "type":"string"
        },
        "cpu_capacity":{
            "readOnly":true,
            "title":"Cpu capacity",
            "type":"integer"
        },
        "errors":{
            "description":"Any error details from the last health check.",
            "minLength":"1",
            "readOnly":true,
            "title":"Errors",
            "type":"string"
        },
        "hostname":{
            "minLength":"1",
            "readOnly":true,
            "title":"Hostname",
            "type":"string",
            "x-nullable":true
        },
        "ip_address":{
            "minLength":"1",
            "readOnly":true,
            "title":"Ip address",
            "type":"string",
            "x-nullable":true
        },
        "last_health_check":{
            "description":"Last time a health check was ran on this instance to refresh cpu, memory, and capacity.",
            "format":"date-time",
            "readOnly":true,
            "title":"Last health check",
            "type":"string",
            "x-nullable":true
        },
        "mem_capacity":{
            "readOnly":true,
            "title":"Mem capacity",
            "type":"integer"
        },
        "memory":{
            "description":"Total system memory of this instance in bytes.",
            "readOnly":true,
            "title":"Memory",
            "type":"integer"
        },
        "uuid":{
            "minLength":"1",
            "readOnly":true,
            "title":"Uuid",
            "type":"string",
            "x-nullable":true
        },
        "version":{
            "minLength":"1",
            "readOnly":true,
            "title":"Version",
            "type":"string",
            "x-nullable":true
        }
    },
    "type":"object"
}