可用方法

连接示例

示例服务器视图/浏览器视图设备 JSON 对象
{
    "Avoid_Simultaneous_Checks": false,
    "Alert_Silence_Min": 28,
    "False_Positive_Check": false,
    "Locations": [
        1,
        4,
        6,
        14,
        15,
        17,
        19,
        23,
        43,
        71,
        73
    ],
    "Tags": [
        "my_device"
    ],
    "ContextParams": [],
    "Send_Uptime_Alert": false,
    "Status_Description": "POSTPONED",
    "Postpone": true,
    "Owner_Device_Id": 0,
    "Frequency": 10800,
    "Filter_Id": 7791,
    "Scheduler_Id": 0,
    "Notifications": {
        "E_Mail_Flag": false,
        "E_Mail_Address": null,
        "E_Mail_TimeInterval_Min": 0,
        "WL_Device_Flag": false,
        "WL_Device_Email_Address": null,
        "WL_Device_TimeInterval_Min": 0,
        "Pager_Flag": false,
        "Pager_Area_Code": null,
        "Pager_Phone": null,
        "Pager_Num_Code": null,
        "Pager_TimeInterval_Min": 0,
        "Phone_Flag": false,
        "Phone_Area_Code": null,
        "Phone_Phone": null,
        "Phone_TimeInterval_Min": 0,
        "SMS_Flag": false,
        "SMS_Phone": null,
        "SMS_TimeInterval_Min": 0,
        "Script_Flag": false,
        "Script_Batch_File_Name": null,
        "Script_TimeInterval_Min": 0,
        "SNMP_TimeInterval_Min": 0,
        "Teams_TimeInterval_Min": 0,
        "Slack_TimeInterval_Min": 0,
        "AlertOps_TimeInterval_Min": 0,
        "PagerDuty_TimeInterval_Min": 0,
        "Notification_Groups": []
    },
    "Id": 47432,
    "Number_Of_Tasks": 1,
    "WaitingForApproval": false,
    "Platform_Id": 1,
    "Package_Id": 52,
    "Name": "FullPageDomain.cs"
}

字段描述

使用这些字段指定 API 请求中有关设备的信息。

领域

类型

描述

Avoid_Simultaneous_Checks

布尔

指示是否允许从多个监视位置同时进行检查。 仅适用于服务器视图设备。

例子:
"Avoid_Simultaneous_Checks": true

Alert_Silence_Min

int32

只读。 定义禁用所有警报的时间段(以分钟为单位)。 要禁用警报,请使用 API:设备API 的禁用警报:多个设备的禁用警报

例子:
"Alert_Silence_Min": 46

False_Positive_Check

布尔

当检测到错误时,我们会运行一系列检查以确保它不是错误警报。 这些检查可能需要一些时间,具体取决于错误类型和设备中的任务数。 这可能会导致停机警报出现一些延迟。 您可以禁用(“true”状态)误报检查以确保立即发出停机警报,但这可能会导致某些“错误”警报。 我们建议不要禁用“误报检查”。

例子:
"False_Positive_Check": false

位置

int32 阵列

包含分配给指定设备的位置 ID 的阵列。 请求中必须指定至少一个位置。

例子:
"Locations": [1, 2, 4, 5, 8]

标签

字符串阵列

包含分配给指定设备的标签名称的阵列。

例子:
"Tags": ["green", "red", "black"]

Send_Uptime_Alert

布尔

启用此选项后,当解决所有检测到的错误时,您将收到警报。

例子:
"Send_Uptime_Alert": false

Status_Description

字符串

只读。 描述当前设备状态。

例子:
"Status_Description": "POSTPONED"

推迟

布尔

可以通过推迟设备在暂停时设置监视。

例子:
"Postpone": true,

Owner_Device_Id

int32

此字段反映所有者设备 ID。

例子:
"Owner_Device_Id": 8534

频率

int32

此字段在几秒钟内反映监控频率。

例子:
"Frequency": 10800

Filter_Id

int32

此字段反映分配给设备的筛选器 ID。

例子:
"Filter_Id": 853

Scheduler_Id

int32

此字段反映分配给设备的调度程序 ID。

例子:
"Scheduler_Id": 534

通知

对象阵列

指示警报设置的列表。

示例#1:
"Notifications":
{
"E_Mail_Flag": true,
"E_Mail_Address": "demo@at.com",
"E_Mail_TimeInterval_Min": 10
}
示例#2:
"Notifications":
{
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}]
}

E_Mail_Flag

布尔

定义是否发送电子邮件警报。

例子:
"E_Mail_Flag": false

E_Mail_Address

字符串

指定电子邮件警报的电子邮件地址。

例子:
"E_Mail_Address": "demo@company.com"

E_Mail_TimeInterval_Min

int32

此字段允许设置电子邮件警报之间的间隔(以分钟为单位)

例子:
"E_Mail_TimeInterval_Min": 15

WL_Device_Flag

布尔

定义是否发送无线设备警报。

例子:
"WL_Device_Flag": false

WL_Device_Email_Address

字符串

此字段指定用于警报的无线设备,例如电话或寻呼机。

例子:
"WL_Device_Email_Address": "wireless@company.com"

WL_Device_TimeInterval_Min

int32

此字段允许设置无线设备警报之间的间隔(以分钟为单位)。

例子:
"WL_Device_TimeInterval_Min": 13

Pager_Flag

布尔

定义是否发送寻呼机警报。

例子:
"Pager_Flag": true

Pager_Area_Code

字符串

寻呼机区号。

例子:
"Pager_Area_Code": "917"

Pager_Phone

字符串

寻呼机电话。

例子:
"Pager_Phone": "3214564"

Pager_Num_Code

字符串

数字寻呼机的代码。

例子:
"Pager_Num_Code": "225"

Pager_TimeInterval_Min

int32

此字段允许在数分钟内设置寻呼器警报之间的间隔。

例子:
"Pager_TimeInterval_Min": 5

Phone_Flag

布尔

定义是否发生电话呼叫警报。 要通过电话接收警报,请将值设置为“true”并指定电话号码。 电话警报是交互式的,允许您在收到警报后推迟后续警报。

例子:
"Phone_Flag": true

Phone_Area_Code

字符串

如果国家/地区代码为“1”(例如,在美国、加拿大和加勒比地区),请输入区号和号码(例如,952-5134349)。 对于所有其他国家/地区代码,请使用前缀“011”、国家/地区代码和电话号码(例如,011-44-95-2244392)。

例子:
"Phone_Area_Cde": "952"

Phone_Phone

字符串

电话号码。

例子:
"Phone_Phone": "5134349"

Phone_TimeInterval_Min

int32

此字段允许设置电话呼叫之间的间隔。

例子:
"Phone_TimeInterval_Min": 2

SMS_Flag

布尔

定义是否发送 SMS 警报。

例子:
"SMS_Flag": false

SMS_Phone

字符串 带有国家/地区代码的电话号码(例如:美国 – 1 952 513 4349;英国 449524 4392)。 不要在号码中使用国际拨号前缀,例如”011″。

例子:
"SMS_Phone": "19525134349"

SMS_TimeInterval_Min

int32

此字段允许设置 SMS 警报之间的间隔。

例子:
"SMS_TimeInterval_Min": 0

Script_Flag

布尔

此字段定义是否将由自定义警报脚本执行警报。

例子:
"Script_Flag": false

Script_Batch_File_Name

字符串

自定义脚本文件名。 脚本必须已安装在服务器上。

例子:
"Script_Batch_File_Name":"alerting.cs"

Script_TimeInterval_Min

int32

此字段允许在自定义脚本警报之间设置间隔。

例子:
"Script_TimeInterval_Min":5

Notification_Groups

对象阵列

指示活动警报组及其 ID 和时间偏移。 Timeshift 是一个选项,允许您创建基于错误条件持续时间的警报升级过程,例如,可以立即通知第一个通知组,第二个通知组 – 停机时间 10 分钟后,第三组通知 – 停机时间 60 分钟后。 警报升级时间间隔从立即到三小时不等。

例子:
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}, {
"Id": 609,
"Time_Shift_Min": 20
}]

Number_Of_Tasks

int32

只读字段。 显示指定设备下的任务数。

例子:
"Number_Of_Tasks": 15

Id

int32

只读字段。 唯一的设备 ID。 在新设备创建时自动分配。 用于在请求中指定设备。

例子:
"Id": 8533

Platform_Id

int32

只读字段。 每个平台(服务器视图、用户视图等)都有自己的 ID。 在此处查看如何获取 平台的ID。

例子:
"Platform_Id": 1

名字

字符串

设备的名称。

例子:
"Name": "new name"