请求网址
获取
https://api.dotcom-monitor.com/config_api_v1/设备 {device_id} /
按 ID 设置设备。
路径参数
领域 | 类型 | 必填 | 描述 |
---|---|---|---|
device_id |
字符串 |
true |
监控设备的独特 ID。 要在平台内请求设备 ID 列表,请参阅 API:按平台获取设备列表。 |
成功响应
字段描述
使用这些字段指定 API 请求中有关设备的信息。
领域 |
类型 |
描述 | ||
Avoid_Simultaneous_Checks |
布尔 |
指示是否允许同时检查多个监视位置。 仅适用于服务器视图设备。
例子:
|
||
Alert_Silence_Min |
int32 |
只读。 当所有警报禁用时,以分钟为内定义时间段。 要禁用警报,请使用 API:设备 或 API 的禁用警报:多个设备的禁用警报。
例子:
|
||
False_Positive_Check |
布尔 |
检测到错误时,我们会运行一系列检查,以确保它不是一个错误警报。 这些检查可能需要一些时间,具体取决于设备中的错误类型和任务数。 这可能会导致停机警报出现一些延迟。 您可以禁用(”true”状态)误报检查以确保立即停机警报,但可能会导致一些”假”警报。 我们建议不要禁用”假阳性检查”。
例子:
|
||
位置 |
int32 阵列 |
包含分配给指定设备的位置 ID 的阵列。 请求中必须指定至少一个位置。
例子:
|
||
标签 |
字符串阵列 |
包含分配给指定设备的标签名称的阵列。
例子:
|
||
Send_Uptime_Alert |
布尔 |
启用此选项后,当解决所有检测到的错误时,您将收到警报。
例子:
|
||
Status_Description |
字符串 |
只读。 描述当前设备状态。
例子:
|
||
推迟 |
布尔 |
可以通过推迟设备在暂停时设置监视。
例子:
|
||
Owner_Device_Id |
int32 |
此字段反映所有者设备 ID。
例子:
|
||
频率 |
int32 |
此字段在几秒钟内反映监控频率。
例子:
|
||
Filter_Id |
int32 |
此字段反映分配给设备的筛选器 ID。
例子:
|
||
Scheduler_Id |
int32 |
此字段反映分配给设备的计划程序 ID。
例子:
|
||
通知 |
对象阵列 |
指示警报设置列表
示例#1:
示例#2:
|
||
E_Mail_Flag |
布尔 |
定义是否将发送电子邮件警报。
例子:
|
||
E_Mail_Address |
字符串 |
指定电子邮件警报的电子邮件地址。
例子:
|
||
E_Mail_TimeInterval_Min |
int32 |
此字段允许在几分钟内设置电子邮件警报之间的间隔
例子:
|
||
WL_Device_Flag |
布尔 |
定义是否发送无线设备警报。
例子:
|
||
WL_Device_Email_Address |
字符串 |
此字段为警报指定无线设备(如电话或寻呼机)。
例子:
|
||
WL_Device_TimeInterval_Min |
int32 |
此字段允许在几分钟内设置无线设备警报之间的间隔。
例子:
|
||
Pager_Flag |
布尔 |
定义是否发送寻呼机警报。
例子:
|
||
Pager_Area_Code |
字符串 |
寻呼机区号。
例子:
|
||
Pager_Phone |
字符串 |
寻呼机电话。
例子:
|
||
Pager_Num_Code |
字符串 |
数字寻呼机的代码。
例子:
|
||
Pager_TimeInterval_Min |
int32 |
此字段允许在数分钟内设置寻呼器警报之间的间隔。
例子:
|
||
Phone_Flag |
布尔 |
定义是否发生电话呼叫警报。 通过电话接收警报,请将值设置为”true”并指定电话号码。 电话警报是交互式的,允许您在收到警报后延迟后续警报。
例子:
|
||
Phone_Area_Code |
字符串 |
如果国家/地区代码为”1″(例如,在美国、加拿大和加勒比海),请输入区号和号码(例如,952-5134349)。 对于所有其他国家/地区代码,请使用前缀”011″、国家/地区代码和电话号码(例如,011-44-95-2244392)。
例子:
|
||
Phone_Phone |
字符串 |
电话号码。
例子:
|
||
Phone_TimeInterval_Min |
int32 |
此字段允许设置电话呼叫之间的间隔。
例子:
|
||
SMS_Flag |
布尔 |
定义是否发送 SMS 警报。
例子:
|
||
SMS_Phone |
字符串 | 带有国家/地区代码的电话号码(例如:美国 – 1 952 513 4349;英国 449524 4392)。 不要在号码中使用国际拨号前缀,例如”011″。
例子:
|
||
SMS_TimeInterval_Min |
int32 |
此字段允许设置 SMS 警报之间的间隔。
例子:
|
||
Script_Flag |
布尔 |
此字段定义是否将通过自定义警报脚本执行警报。
例子:
|
||
Script_Batch_File_Name |
字符串 |
自定义脚本文件名。 脚本必须已在服务器上安装。
例子:
|
||
Script_TimeInterval_Min |
int32 |
此字段允许在自定义脚本警报之间设置间隔。
例子:
|
||
Notification_Groups |
对象阵列 |
指示活动警报组及其 ID 和时间偏移。 时差是一个选项,允许您创建基于错误条件持续时间的警报升级过程,例如,第一个通知组可以立即通知,第二个通知组在停机 10 分钟后,在 60 分钟停机后第三组。 警报升级时间间隔从立即到三小时不等。
例子:
|
||
Number_Of_Tasks |
int32 |
只读字段。显示指定设备下的任务数。
例子:
|
||
int32 |
只读字段。 唯一的设备 ID。 在新设备创建时自动分配。 用于在请求中指定设备。
例子:
|
|||
Platform_Id |
int32 |
只读字段。 每个平台(服务器查看、用户视图等)都有自己的 ID。 在此处查看如何获取 平台的ID。
例子:
|
||
名字 |
字符串 |
设备的名称。
例子:
|