Remediation Service
Remediation Service Create Remediation
Creates a new remediation for an instance.
Remediations created via the API goes directly to PENDING state.
Our system may trigger automated remediations that require approval. These remediations are created with PENDING_APPROVAL state. The user must call /approve to start the actual remediation process. These operations can also be rejected by calling /reject.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
cluster_id*string
instance_id*string
Query Parameters
remediation_id?string
Client-specified ID for idempotency.
Request Body
application/json
Remediation represents a node remediation request for an instance. An instance can have multiple remediations over time (e.g., failed attempts followed by retries).
mode*string
Remediation mode specifies how the remediation should be performed.
REMEDIATION_MODE_VM_ONLY: Deletes the VM and provisions a new one on any available host.REMEDIATION_MODE_HOST_AWARE: Cordons the host, deletes the VM, and provisions a new one on a different host.REMEDIATION_MODE_EVICT_WITHOUT_REPLACEMENT: Evicts the VM without provisioning a replacement.REMEDIATION_MODE_REBOOT_VM: Reboots the VM in place.REMEDIATION_MODE_HOST_POWER_CYCLE: Cordons and power-cycles the bare-metal host while preserving host and node identity.
Value in
- "REMEDIATION_MODE_VM_ONLY"
- "REMEDIATION_MODE_HOST_AWARE"
- "REMEDIATION_MODE_EVICT_WITHOUT_REPLACEMENT"
- "REMEDIATION_MODE_REBOOT_VM"
- "REMEDIATION_MODE_HOST_POWER_CYCLE"
reason?string
User-provided reason for the remediation.
Response Body
application/json
curl -X POST "https://example.com/compute/clusters/string/instances/string/remediations" \ -H "Content-Type: application/json" \ -d '{ "mode": "REMEDIATION_MODE_VM_ONLY" }'{ "id": "string", "cluster_id": "string", "instance_id": "string", "mode": "REMEDIATION_MODE_VM_ONLY", "trigger": "REMEDIATION_TRIGGER_MANUAL", "state": "PENDING_APPROVAL", "reason": "string", "active_health_check_run_id": "string", "passive_health_check_event_id": "string", "requested_by": "string", "create_time": "2019-08-24T14:15:22Z", "reviewed_by": "string", "review_time": "2019-08-24T14:15:22Z", "review_comment": "string", "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "error_message": "string", "update_time": "2019-08-24T14:15:22Z", "instance_name": "string", "linked_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" } } } ]}