Health Check Service

List passive health check alerts

GET
/compute/passive_health_check_alerts

Lists passive health check alerts. Filters combine across axes; empty values skip that axis.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

intent_id?string

Remediation intent ID to filter by.

instance_id?string

Instance ID to filter by.

cluster_id?string

Optional instance cluster ID to filter by. Required for non-admin callers.

page_size?integer

Max number of results to return.

Default50
page_token?string

Opaque pagination token from the previous response.

status?string

Lifecycle filter. Omit to return firing alerts.

Value in

  • "PHC_ALERT_STATUS_FIRING"
  • "PHC_ALERT_STATUS_RESOLVED"
  • "PHC_ALERT_STATUS_ALL"
severity_filter?array<>

Severity tiers to include. Omit or pass an empty array to include all severities.

order_by?string

Sort order for returned alerts. Omit for newest alerts first.

Default"PHC_ALERT_ORDER_STARTED_AT_DESC"

Value in

  • "PHC_ALERT_ORDER_STARTED_AT_ASC"
  • "PHC_ALERT_ORDER_STARTED_AT_DESC"

Response Body

application/json

curl -X GET "https://example.com/compute/passive_health_check_alerts"
{  "alerts": [    {      "passive_health_check_alert_id": "string",      "instance_id": "string",      "cluster_id": "string",      "target_vm": "string",      "alert_name": "string",      "severity": "PHC_SEVERITY_INFO",      "annotations": {        "property1": "string",        "property2": "string"      },      "started_at": "2019-08-24T14:15:22Z",      "resolved_at": "2019-08-24T14:15:22Z",      "node_remediation_intent_id": "string",      "annotation": {        "title": "string",        "description": "string",        "summary_line": "string",        "xid": {          "events": [            {              "xid_code": "string",              "mnemonic": "string",              "count": 0            }          ]        },        "slurm_node_unavailable": {          "reason": "string"        }      }    }  ],  "next_page_token": "string"}