Struct HealthChecks 

pub struct HealthChecks<'a> { /* private fields */ }

Health check routes, from Client::health_checks.

A check belongs to one record value and is addressed by that value’s uuid (record_id). Access follows the value’s zone.

Implementations

impl<'a> HealthChecks<'a>

pub async fn get(&self, record_id: Uuid) -> Result<HealthCheck>

The check of a record value, with its last result.

GET /api/v1/health-checks/:record_id

Errors

ErrorCode::NotFound if the value has no check.

pub async fn create(&self, check: &NewHealthCheck) -> Result<HealthCheck>

Adds a check to a record value and switches the value’s host_health to Auto, so Core starts running it right away. The value counts as healthy until the first run says otherwise.

POST /api/v1/health-checks

Errors

• ErrorCode::Conflict if the value already has a check.
• ErrorCode::Validation for out-of-range timings (see NewHealthCheck) or a bad config.

Examples

use dinio_sdk::models::{HealthCheckConfig, NewHealthCheck, TcpCheck};

let check = NewHealthCheck {
    record_id: value.uuid,
    config: HealthCheckConfig::Tcp(TcpCheck { host: "192.0.2.10".into(), port: 443 }),
    name: Some("web".into()),
    interval: 60,
    timeout: 5,
    retries: None,
    retry_interval: None,
};
client.health_checks().create(&check).await?;

pub async fn update( &self, record_id: Uuid, patch: &HealthCheckPatch, ) -> Result<HealthCheck>

Changes a check; fields left None stay as they are.

PATCH /api/v1/health-checks/:record_id

Errors

• ErrorCode::NotFound if the value has no check.
• ErrorCode::Validation if the result would have timeout >= interval, or the config does not fit the check’s type.

pub async fn delete(&self, record_id: Uuid) -> Result<()>

Removes the check of a record value. A value on Auto falls back to None (always healthy); Up and Down stay.

DELETE /api/v1/health-checks/:record_id

Errors

ErrorCode::NotFound if the value has no check.