Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Query & Overview
POSTMonitoringSince 1.0SynchronousAuth Required

AnalyzeImpact

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • rootResourceTypeStringRequired

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

    Example: host

  • rootResourceIdStringRequired

    UUID of the failing root resource

    Example: host-001-xyz

  • failureTypeStringRequired

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

    Example: hardware_failure

Responses

200 OK

On success, this API returns the following response structure.

  • rootResourceObject

    Root resource

    • uuidString

      Unique identifier of the resource

      Example: res-abc-001

    • nameString

      Display name of the resource

      Example: primary-host-01

    • stateString

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

      Example: running

    • typeString

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

      Example: host

  • affectedResourcesList

    Affected resources

    Example: (nested array)

    • typeString

      Resource type of the affected entity

      Example: vm

    • uuidString

      Unique identifier of the affected resource

      Example: vm-002-abc

    • nameString

      Display name of the affected resource

      Example: db-server-01

    • impactString

      Description of the impact on this resource

      Example: service interruption

    • levelInteger

      Depth level in the impact propagation graph

      Example: 1

  • summaryObject

    Summary for this resource

    • totalAffectedVmsInteger

      Total number of VMs affected by the failure

      Example: 12

    • totalAffectedHostsInteger

      Total number of hosts affected by the failure

      Example: 2

    • affectedByTypeLinkedHashMap

      Impact breakdown by affected resource type

      Example: (nested object)

  • recommendedActionsList

    Recommended actions

    Example: (nested array)

    • priorityString

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

      Example: high

    • actionString

      Short action label for display

      Example: Migrate VMs to standby host

    • descriptionString

      Detailed description of the recommended action and its rationale

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

Endpoint

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

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

Operation ID

AnalyzeImpact

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/topology/impact-analysis' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"rootResourceType":"host","rootResourceId":"host-001-xyz","failureType":"hardware_failure"}'

Response Example

200
{
  "rootResource": {},
  "affectedResources": [
    {}
  ],
  "summary": {},
  "recommendedActions": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history