Last updated: June 26, 2024

DQOps REST API healthcheck operations

Health check operations for checking if the DQOps service is up and operational. Used for monitoring by load balancers.

---

is_healthy

Checks if the DQOps instance is healthy and operational. Returns a text "OK" and a HTTP status code 200 when the service is active and can accept jobs, or returns a text "UNAVAILABLE" and a HTTP status code 503 when the service is still starting or is shutting down.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/ishealthy

Return value

Property name	Description	Data type
string		string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/ishealthy^
    -H "Accept: application/json"

Expand to see the returned result

"sample_string_value"

Execution

from dqops import client
from dqops.client.api.healthcheck import is_healthy

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = is_healthy.sync(
    client=dqops_client
)

Expand to see the returned result

'sample_string_value'

Execution

from dqops import client
from dqops.client.api.healthcheck import is_healthy

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await is_healthy.asyncio(
    client=dqops_client
)

Expand to see the returned result

'sample_string_value'

Execution

from dqops import client
from dqops.client.api.healthcheck import is_healthy

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = is_healthy.sync(
    client=dqops_client
)

Expand to see the returned result

'sample_string_value'

Execution

from dqops import client
from dqops.client.api.healthcheck import is_healthy

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await is_healthy.asyncio(
    client=dqops_client
)

Expand to see the returned result

'sample_string_value'