Flashcat API (English)
API reference
Docs
中文
Flashcat API (English)
  • Open API
    • Quick Start
    • About Pagination
    • Member Management
    • Team Management
    • Schedule Management
    • Information Retrieval
    • Preference Settings
    • Channel
    • Template Management
    • Incident Management
    • Alert Management
      • Group View
      • Alert DetailsPOST
      • Close AlertPOST
      • Alert List - Card ViewPOST
      • Alert ListPOST
      • Alert List - Query by IDPOST
      • Associated Event ListPOST
      • TimelinePOST
      • Merge into IncidentPOST
    • Change Management
    • Insights
    • Custom Fields
    • Service Calendar
    • Label Enhancement
    • Alert Processing
    • Integration Routing
    • License Management
    • Insights (New)
  • Event API
  • Webhook
logoPowered by Apifox
  1. Open API
  2. Alert Management

Alert Details

POST/alert/info

Request

Header Params
Content-Type
string 
required
Example:
application/json
Body Params application/json
alert_id
string 
Alert ID
required
Example
{
  "alert_id": "string"
}

Request samples

Responses

成功(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
error
object (DutyError) 
optional
code
enum<string> 
Error code
required
Allowed values:
InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist
message
string 
Error description
required
data
object (Alert) 
optional
alert_id
string 
Alert ID
required
channel_id
integer 
Channel ID
required
channel_name
string 
Channel name
required
data_source_id
integer 
Integration ID
required
data_source_name
string 
Integration name
required
data_source_type
string 
Integration type
required
data_source_ref_id
string 
Integration association ID
required
title
string 
Title
required
title_rule
string 
Title rule
optional
description
string 
Description
optional
alert_key
string 
Event correlation basis
required

Alerts with same alert_key will be merged into one alert

alert_severity
enum<string> 
Severity
required
Allowed values:
InfoWarningCritical
alert_status
enum<string> 
Alert status
required
Allowed values:
InfoWarningCriticalOk
progress
enum<string> 
Processing progress
required
Allowed values:
TriggeredProcessingClosed
start_time
integer 
First trigger time
required

Alert may frequently occur and recover, this is the first trigger time

last_time
integer 
Last merged event time
required

Only updated when merging new alert events, different from updated_at

end_time
integer 
Alert end time
optional

Updated when alert recovers. For auto-recovery, alert will auto-close and close_time will be updated simultaneously

close_time
integer 
Manual closure time
optional

Closure does not affect alert recovery

created_at
integer 
Created time
required

Database record creation time, generally same as start_time

updated_at
integer 
Updated time
required

Database record update time, different from last_time, this field will be updated for both manual and automatic alert updates

labels
object (Labels) 
Label list
required
events
array[object (AlertEvent) {11}] 
Associated events
optional
responder_id
integer 
Responder ID
optional
incident
object 
Associated incident
optional
event_cnt
integer 
Cumulative aggregated event count
optional
ever_muted
boolean 
Whether has been silenced/inhibited
optional
Example
Not configured
Last modified: 2 个月前