通知指寄送警告的目的地每项通知必须是各种不同的通知类型,并随时间演化
华体会联盟hth使用 webhook类型通知Rackspace监控发布JSON格式化数据到用户指定的URL
默认值ntTechnicalContactsEmail
通知邮件所有文件技术联系人可使用默认通知创建通知计划,就像对其它通知一样通知只通知通知计划定义的状态变化时通知技术联系人
属性化
名称 | 描述性 | 验证 |
---|---|---|
细节 | ah通知细节基于通知类型 | Hash[String,String介于1至255字符间长:非空字符串,String介于1至4096字符长 数组或对象数介于0至256 |
标签标签 | 友称通知 | 字符串从1到255长 |
类型 | 通知类型发送 | 字符串 i/i/ebckerduce,sms管理技术联系人Email,atomHoper |
元数据 | 任意密钥/值对 | 可选性 哈希[ string, string介于1至255字符间长:String,string介于1至255字符间长 数组或对象数介于0至256 |
使用通知API创建、查看和管理通知
创建通知
POST/通知
使用有效属性集创建监测系统新通知通知属性表格内
下表显示此操作可能的响应码 :
响应代码 | 名称 | 描述性 |
---|---|---|
201 | 接受 | 位置头含新创建检查链路 |
400 | 坏请求 | 系统请求中接收无效值 |
401 | 未授权 | 系统接收用户请求未经认证 |
403 | 禁止 | 系统收到用户无权请求 |
500 | 内部服务器错误 | 遇上意外条件 |
503 | 服务无可用 | 系统经历重负载或系统其他故障 |
下表显示请求页眉参数
名称 | 类型 | 描述性 |
---|---|---|
X-AUT-Token | 字符串(必备) | 有效验证令牌并存行政访问细节见获取证书 |
例子创建 webhook通知:JSON请求
{{
标签:网钩#1
类型:webhook
细节问题
url:https://systems.example.org/alert...
}
}
实例创建邮件通知:JSON请求
{{
标签:我的邮箱#1
类型电子信箱
细节问题
地址:[email protected]...
}
}
例子创建PagerDuty通知:JSON请求
{{
标签: 我的PeclerDuty#1
类型:页工值班
细节问题
"service_key": "abcd1234abcd1234abcd1234abcd1234"
}
}
创建短信通知:JSON请求
{{
标签: 我的短信#1
类型:sms
细节问题
phone_number:+1551234567
}
}
操作不返回响应体
测试通知
POST/测试通知
操作允许测试通知后再创建实际通知出自实际报警消息出自的同一服务器这使你能够验证防火墙配置得当
下表显示此操作可能的响应码 :
响应代码 | 名称 | 描述性 |
---|---|---|
二百 | 好 | 请求完成 |
400 | 坏请求 | 系统请求中接收无效值 |
401 | 未授权 | 系统接收用户请求未经认证 |
403 | 禁止 | 系统收到用户无权请求 |
500 | 内部服务器错误 | 遇上意外条件 |
503 | 服务无可用 | 系统经历重负载或系统其他故障 |
下表显示请求页眉参数
名称 | 类型 | 描述性 |
---|---|---|
X-AUT-Token | 字符串(必备) | 有效验证令牌并存行政访问细节见获取证书 |
示例测试通知:JSON请求
{{
类型:webhook
细节问题
url:http://my.web-server.com:5981/...
}
}
示例测试通知:JSON响应
{{
状态: 成功
消息集 成功Webhook成功执行
}
链表通知
获取/通知
列表通知账号使用/notifications?id=notificationOneId & id=notificationTwoId
过滤结果只包括有关通知的信息
操作可分解信息见粘贴集合.
下表显示此操作可能的响应码 :
响应代码 | 名称 | 描述性 |
---|---|---|
二百 | 好 | 请求完成 |
401 | 未授权 | 系统接收用户请求未经认证 |
403 | 禁止 | 系统收到用户无权请求 |
500 | 内部服务器错误 | 遇上意外条件 |
503 | 服务无可用 | 系统经历重负载或系统其他故障 |
下表显示请求页眉参数
名称 | 类型 | 描述性 |
---|---|---|
X-AUT-Token | 字符串(必备) | 有效验证令牌并存行政访问细节见获取证书 |
注解
操作不接受请求体
示例列表通知:JSON响应
{{
值:
{{
id:ntaAA
标签:网钩#1
类型:webhook
细节问题
url:https://systems.example.org/alert...
}
}
万事通
元数据
计数数数:1
限值: 50
标志号:Null
ext_marce:Null
exthref无效
}
}
测试现有通知
POST /notifications/{notificationId}/test
操作允许测试现有通知通知发自报警消息发自的同一个服务器测试的一个用法是验证防火墙配置得当
下表显示此操作可能的响应码 :
响应代码 | 名称 | 描述性 |
---|---|---|
二百 | 好 | 请求完成 |
400 | 坏请求 | 系统请求中接收无效值 |
401 | 未授权 | 系统接收用户请求未经认证 |
403 | 禁止 | 系统收到用户无权请求 |
500 | 内部服务器错误 | 遇上意外条件 |
503 | 服务无可用 | 系统经历重负载或系统其他故障 |
下表显示请求页眉参数
名称 | 类型 | 描述性 |
---|---|---|
X-AUT-Token | 字符串(必备) | 有效验证令牌并存行政访问细节见获取证书 |
注解
操作不接受请求体
实例测试现有通知:JSON响应
{{
状态: 成功
消息集 成功Webhook成功执行
}
通过ID获取通知
GET /notifications/{notificationId}
返回指定通知信息
下表显示此操作可能的响应码 :
响应代码 | 名称 | 描述性 |
---|---|---|
二百 | 好 | 请求完成 |
401 | 未授权 | 系统接收用户请求未经认证 |
403 | 禁止 | 系统收到用户无权请求 |
500 | 内部服务器错误 | 遇上意外条件 |
503 | 服务无可用 | 系统经历重负载或系统其他故障 |
下表显示请求页眉参数
名称 | 类型 | 描述性 |
---|---|---|
X-AUT-Token | 字符串(必备) | 有效验证令牌并存行政访问细节见获取证书 |
注解
操作不接受请求体
示例通过ID获取通知:JSON响应
{{
id:ntaAA
标签:网钩#1
类型:webhook
细节问题
url:https://systems.example.org/alert...
}
}
更新通知
PUT /notifications/{notificationId}
使用有效属性集更新监控系统通知通知属性表格内
下表显示此操作可能的响应码 :
响应代码 | 名称 | 描述性 |
---|---|---|
204 | 无内容 | 服务器满足请求不返回响应体 |
400 | 坏请求 | 系统请求中接收无效值 |
401 | 未授权 | 系统接收用户请求未经认证 |
403 | 禁止 | 系统收到用户无权请求 |
404 | 未找到 | URL、实体或帐户请求系统中找不到 |
500 | 内部服务器错误 | 遇上意外条件 |
503 | 服务无可用 | 系统经历重负载或系统其他故障 |
下表显示请求页眉参数
名称 | 类型 | 描述性 |
---|---|---|
X-AUT-Token | 字符串(必备) | 有效验证令牌并存行政访问细节见获取证书 |
实例更新通知:JSON请求
{{
类型:webhook
细节问题
url:https://systems.example.org/new_alert...
}
}
操作不返回响应体
删除通知
DELETE /notifications/{notificationId}
从用户账户删除通知
下表显示此操作可能的响应码 :
响应代码 | 名称 | 描述性 |
---|---|---|
204 | 无内容 | 服务器满足请求不返回响应体 |
401 | 未授权 | 系统接收用户请求未经认证 |
403 | 禁止 | 系统收到用户无权请求 |
404 | 未找到 | URL、实体或帐户请求系统中找不到 |
500 | 内部服务器错误 | 遇上意外条件 |
503 | 服务无可用 | 系统经历重负载或系统其他故障 |
下表显示请求页眉参数
名称 | 类型 | 描述性 |
---|---|---|
X-AUT-Token | 字符串(必备) | 有效验证令牌并存行政访问细节见获取证书 |
注解
操作不接受请求体
操作不返回响应体