Skip to main content
ZStack
Monitoring & Collection/Auto Remediation

GenerateRemediationActions

Generate candidate remediation actions for a given resource failure scenario

POST/api/v1/monitoring/remediation/actions

Operation ID

GenerateRemediationActions

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • resourceType
    StringRequired

    Type of the failing resource

    Example: host

  • resourceId
    StringRequired

    UUID of the failing resource

    Example: host-001-xyz

  • resourceName
    StringRequired

    Display name of the failing resource

    Example: compute-node-01

  • failureType
    StringRequired

    Type of failure to remediate

    Example: hardware_failure

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • id
      String

      Unique identifier of the remediation action

      Example: action-001-abc

    • type
      String

      Type of the remediation action (e.g. migrate_vm, restart_service)

      Example: migrate_vm

    • description
      String

      Human-readable description of what this action does

      Example: Migrate all VMs from the failing host to available standby hosts

    • estimatedDuration
      String

      Estimated time to complete this action

      Example: 5m

    • riskLevel
      String

      Risk level of executing this action (low, medium, high)

      Example: medium

    • preconditions
      List

      Preconditions for this resource

      Example: item1,item2

    • targetResources
      List

      Target resources

      Example: (nested array)

      • type
        String

        Resource type of the migration target (e.g. host)

        Example: host

      • id
        String

        UUID of the target resource

        Example: host-002-backup

      • name
        String

        Display name of the target resource

        Example: standby-node-01

      • capacity
        String

        Available capacity description on the target resource

        Example: 80%

      • canMigrateVms
        Integer

        Number of VMs that can be migrated to this target (1 = yes, 0 = no)

        Example: 1

    • score
      Long

      Confidence score for this action recommendation (0.0 – 1.0)

      Example: 0.92