Skip to main content
ZStack
Monitoring & Collection/Monitoring Query & Overview

AnalyzeImpact

Analyze the blast radius of a hypothetical resource failure and recommend remediation actions

POST/api/v1/monitoring/topology/impact-analysis

Operation ID

AnalyzeImpact

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

  • rootResourceType
    StringRequired

    Resource type of the root failure (e.g. host, cluster)

    Example: host

  • rootResourceId
    StringRequired

    UUID of the failing root resource

    Example: host-001-xyz

  • failureType
    StringRequired

    Type of failure being simulated (e.g. hardware_failure, network_loss)

    Example: hardware_failure

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • rootResource
    Object

    Root resource

    • uuid
      String

      Unique identifier of the resource

      Example: res-abc-001

    • name
      String

      Display name of the resource

      Example: primary-host-01

    • state
      String

      Current state of the resource (e.g. running, stopped, error)

      Example: running

    • type
      String

      Resource type (e.g. vm, host, cluster, zone)

      Example: host

  • affectedResources
    List

    Affected resources

    Example: (nested array)

    • type
      String

      Resource type of the affected entity

      Example: vm

    • uuid
      String

      Unique identifier of the affected resource

      Example: vm-002-abc

    • name
      String

      Display name of the affected resource

      Example: db-server-01

    • impact
      String

      Description of the impact on this resource

      Example: service interruption

    • level
      Integer

      Depth level in the impact propagation graph

      Example: 1

  • summary
    Object

    Summary for this resource

    • totalAffectedVms
      Integer

      Total number of VMs affected by the failure

      Example: 12

    • totalAffectedHosts
      Integer

      Total number of hosts affected by the failure

      Example: 2

    • affectedByType
      LinkedHashMap

      Impact breakdown by affected resource type

      Example: (nested object)

  • recommendedActions
    List

    Recommended actions

    Example: (nested array)

    • priority
      String

      Priority level of this recommended action (high, medium, low)

      Example: high

    • action
      String

      Short action label for display

      Example: Migrate VMs to standby host

    • description
      String

      Detailed description of the recommended action and its rationale

      Example: Move affected VMs to host-backup-01 to restore service availability