Alert interface

The alert.

Extends

Properties

alertType

The type of the alert

appearedAtSourceTime

The source time at which the alert was raised

appearedAtTime

The UTC time at which the alert was raised

clearedAtSourceTime

The source time at which the alert was cleared

clearedAtTime

The UTC time at which the alert was cleared

detailedInformation

More details about the alert

errorDetails

The details of the error for which the alert was raised

recommendation

The recommended action for the issue raised in the alert

resolutionReason

The reason for resolving the alert

scope

The scope of the alert

severity

The severity of the alert

source

The source at which the alert was raised

status

The current status of the alert

title

The title of the alert

Inherited Properties

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

kind

The Kind of the object. Currently only Series8000 is supported

name

The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

type

The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

alertType

The type of the alert

alertType: string

Property Value

string

appearedAtSourceTime

The source time at which the alert was raised

appearedAtSourceTime: Date

Property Value

Date

appearedAtTime

The UTC time at which the alert was raised

appearedAtTime: Date

Property Value

Date

clearedAtSourceTime

The source time at which the alert was cleared

clearedAtSourceTime?: Date

Property Value

Date

clearedAtTime

The UTC time at which the alert was cleared

clearedAtTime?: Date

Property Value

Date

detailedInformation

More details about the alert

detailedInformation?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

errorDetails

The details of the error for which the alert was raised

errorDetails?: AlertErrorDetails

Property Value

recommendation

The recommended action for the issue raised in the alert

recommendation?: string

Property Value

string

resolutionReason

The reason for resolving the alert

resolutionReason?: string

Property Value

string

scope

The scope of the alert

scope: AlertScope

Property Value

severity

The severity of the alert

severity: AlertSeverity

Property Value

source

The source at which the alert was raised

source: AlertSource

Property Value

status

The current status of the alert

status: AlertStatus

Property Value

title

The title of the alert

title: string

Property Value

string

Inherited Property Details

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From BaseModel.id

kind

The Kind of the object. Currently only Series8000 is supported

kind?: "Series8000"

Property Value

"Series8000"

Inherited From BaseModel.kind

name

The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From BaseModel.name

type

The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From BaseModel.type