Skip to main content
Version: 2.9.0

Error Models

Introduction

The Error Models section outlines the structure of error responses and key entities like Job, Node, Policy, and Zone in the Superna Eyeglass API, providing essential details for diagnosing and handling errors.

ErrorModel

FieldTypeDescription
codeIntegerError code
messageStringError message description

Job

FieldTypeDescription
failoverTargetJob_failoverTargetTarget details for the failover job
finishedLongThe end time of the job
idStringUnique identifier for the job
jobTypeStringThe type of the job (zone_failover or policy_failover)
nameStringHuman-readable name for this job
sourceNodeNodeThe source node for this job
startedLongThe start time of the job
successBooleanTrue if there were no errors
targetNodeNodeThe target node for this job

Node

FieldTypeDescription
idStringUnique identifier for the node
ipStringPrimary IP address of the node
nameStringUnique name of the node

Policy

FieldTypeDescription
failoverReadinessStringEnumeration describing the failover readiness of the policy (ok, warning, error)
idStringUnique identifier for the policy
nameStringSyncIQ Policy Name
targetNodeNode that is the target for this SyncIQ policy
zoneZoneAccess zone for this policy

Zone

FieldTypeDescription
failoverReadinessStringEnumeration describing the failover readiness of the zone (ok, warning, error)
idStringUnique identifier for the zone
nameStringAccess Zone Name

Inline_response

FieldTypeDescription
idStringUnique identifier

Job_failoverTarget

FieldTypeDescription
zoneZoneThe access zone being failed over
policiesarray[Policy]The policies being failed over