本产品(
运维事件中心/2021-04-13
)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
集成配置
API | 标题 | API概述 |
---|---|---|
CreateIntegrationConfig | 创建集成配置 | 创建集成配置。 |
DisableIntegrationConfig | 禁用集成配置 | 禁用集成配置。 |
EnableIntegrationConfig | 启用集成配置 | 启用集成配置。 |
GetIntegrationConfig | 集成配置详情 | 集成配置详情 。 |
ListIntegrationConfigs | 集成配置列表 | 集成配置列表。 |
ListIntegrationConfigTimelines | 集成配置操作日志 | 集成配置操作日志。 |
ConfirmIntegrationConfig | 确认集成配置 | 确认集成配置。 |
DeleteIntegrationConfig | 删除集成配置 | 删除集成配置。 |
UpdateIntegrationConfig | 集成配置更新 | 集成配置更新。 |
RefreshIntegrationConfigKey | 刷新集成key | 刷新集成key。 |
人员
API | 标题 | API概述 |
---|---|---|
GetUserGuideStatus | 获取用户引导状态 | 获取用户引导状态。 |
UpdateUserGuideStatus | 更新用户引导状态 | 更新用户引导状态。 |
CreateUser | 创建人员 | 创建人员。 |
DeleteUser | 删除用户 | 删除用户。 |
GetUser | 查看用户详情 | 查看用户详情。 |
ListUsers | 用户列表 | 用户列表。 |
UpdateUser | 人员信息更新 | 人员信息更新。 |
ListUserSerivceGroups | 用户预览 | 用户预览 。 |
服务组
API | 标题 | API概述 |
---|---|---|
ListServiceGroupMonitorSourceTemplates | 查询服务组消息模板列表 | 查询服务组消息模板列表。 |
ListDataReportForServiceGroup | 查询服务组事件统计报表 | 分页查询服务组统计数据 。 |
CheckWebhook | 校验webhook | 校验webhook地址有效性。 |
EnableServiceGroupWebhook | 启用服务组的webhook | 启用服务组的webhook。 |
CreateServiceGroup | 创建服务组 | 创建服务组。 |
DeleteServiceGroup | 删除服务组 | 删除服务组。 |
DeleteServiceGroupUser | 删除服务组人员 | 删除服务组人员。 |
GetServiceGroup | 查看服务组详情 | 查看服务组详情。 |
ListServiceGroups | 查询服务组列表 | 查询服务组列表。 |
UpdateServiceGroup | 服务组编辑 | 服务组编辑。 |
DisableServiceGroupWebhook | 禁用服务组的webhook | 禁用服务组的webhook。 |
排班
API | 标题 | API概述 |
---|---|---|
GetServiceGroupSpecialPersonScheduling | 查询指定人员的服务组排班 | 查询指定人员的服务组排班。 |
GetServiceGroupSchedulingPreview | 预览服务组排班 | 预览服务组排班。 |
GetServiceGroupPersonScheduling | 查询某用户服务组排班 | 查询某用户服务组排班。 |
CreateServiceGroupScheduling | 新增服务组排班 | 新增服务组排班。 |
GetServiceGroupScheduling | 查询服务组排班详情 | 查询服务组排班详情。 |
UpdateServiceGroupSpecialDayScheduling | 修改指定日期的服务组排班 | 修改指定日期的服务组排班。 |
UpdateServiceGroupScheduling | 修改服务组排班 | 修改服务组排班。 |
服务
API | 标题 | API概述 |
---|---|---|
CreateService | 创建服务 | 创建服务。 |
DeleteService | 删除服务 | 删除服务。 |
GetService | 查询服务详情 | 查询服务详情。 |
ListServices | 查看服务列表 | 查看服务列表。 |
UpdateService | 更新服务 | 更新服务。 |
流转规则
API | 标题 | API概述 |
---|---|---|
CreateRouteRule | 创建流转规则 | 创建流转规则。 |
DeleteRouteRule | 删除流转规则 | 删除流转规则。 |
DisableRouteRule | 禁用规则 | 禁用规则。 |
EnableRouteRule | 启用规则 | 启用规则。 |
GetRouteRule | 查看规则详情 | 查看规则详情。 |
ListRouteRules | 查询规则列表 | 查询规则列表。 |
UpdateRouteRule | 编辑流转规则 | 编辑流转规则。 |
VerifyRouteRule | 验证流转规则 | 验证流转规则。 |
通知订阅
API | 标题 | API概述 |
---|---|---|
CreateSubscription | 创建通知订阅 | 创建通知订阅。 |
DeleteSubscription | 删除通知订阅 | 删除通知订阅。 |
EnableSubscription | 启用通知订阅 | 启用通知订阅 。 |
UpdateSubscription | 更新通知订阅 | 更新通知订阅。 |
GetSubscription | 通知订阅详情 | 通知订阅详情。 |
DisableSubscription | 禁用通知订阅 | 禁用通知订阅。 |
ListSubscriptions | 通知订阅列表 | 通知订阅列表。 |
事件
API | 标题 | API概述 |
---|---|---|
CreateIncidentSubtotal | 事件新增小计 | 事件新增小计。 |
ListIncidentSubtotals | 查询事件小计 | 查询事件小计。 |
GetIncidentListByIdList | 根据事件ID查询事件详情 | 根据事件Id查询事件详情。 |
DeleteIncident | 删除事件 | 删除事件。 |
CreateIncident | 手动新增事件 | 手动新增事件。 |
DeliverIncident | 事件转交 | 事件转交。 |
GetIncident | 事件详情 | 事件详情。 |
GetIncidentStatistics | 事件统计 | 事件统计。 |
FinishIncident | 完成事件 | 完结事件。 |
UpdateIncident | 更新事件 | 更新事件。 |
RespondIncident | 事件响应 | 事件响应。 |
ListIncidents | 事件列表 | 事件列表。 |
ListIncidentDetailTimelines | 事件详情动态 | 事件详情动态。 |
ListIncidentTimelines | 事件动态 | 事件动态。 |
相似事件 | 相似事件 | |
GetIncidentSubtotalCount | 获取相似事件相关小计数量 | 获取相似事件相关小计数量。 |
GetSimilarIncidentStatistics | 相似事件列表 | 相似事件列表。 |
报警
API | 标题 | API概述 |
---|---|---|
ListTrendForSourceEvent | 查询告警源趋势统计数据 | 查询告警源趋势统计数据。 |
ListSourceEventsForMonitorSource | 查询最近告警列表 | 查询最近告警列表。 |
ListSourceEvents | 查询原始告警列表 | 查询原始告警列表。 |
ListAlerts | 报警列表查询 | 报警列表查询。 |
GetEvent | 查询最近一次告警 | 查询最近一次告警 。 |
故障
全局配置
API | 标题 | API概述 |
---|---|---|
GetResourceStatistics | 获取资源统计 | 获取资源统计。 |
ListConfigs | 码表配置 | 获取全部动态码表配置项。 |
ListDictionaries | 枚举字典接口 | 枚举字典接口。 |
ListMonitorSources | 监控源列表 | 监控源列表。 |
移动应用
API | 标题 | API概述 |
---|---|---|
CreateTenantApplication | 创建移动应用 | 创建移动应用。 |
GetTenantApplication | 移动应用详情 | 移动应用详情。 |
业务监控
API | 标题 | API概述 |
---|---|---|
PushMonitor | API集成 | 业务监控数据推送,业务监控数据保存。 |
升级计划
API | 标题 | API概述 |
---|---|---|
ListEscalationPlanServices | 升级计划范围对象已选择的列表 | 升级计划范围对象(服务)已选择的列表。 |
CreateEscalationPlan | 创建升级计划 | 创建升级计划。 |
DeleteEscalationPlan | 删除升级计划 | 删除升级计划。 |
DisableEscalationPlan | 禁用升级计划 | 禁用升级计划。 |
EnableEscalationPlan | 启用升级计划 | 启用升级计划。 |
GetEscalationPlan | 升级计划详情 | 获取指定动态码表的详细信息。 |
ListEscalationPlans | 升级计划列表 | 升级计划列表。 |
UpdateEscalationPlan | 更新升级计划 | 更新升级计划。 |
富文本
API | 标题 | API概述 |
---|---|---|
CreateRichText | 创建富文本 | 创建富文本。 |
GetRichText | 获取富文本信息 | 获取富文本信息。 |
UpdateRichText | 更新富文本 | 更新富文本。 |
其他
API | 标题 | API概述 |
---|---|---|
ListIncidentDetailEscalationPlans | 事件关联的升级计划列表 | 事件关联的升级计划列表。 |
GetHomePageGuidance | 查询首页配置引导 | 查询首页配置引导。 |
ListChartDataForServiceGroup | 数据报表图表数据接口(服务组) | 数据报表图表数据接口(服务组)。 |
ListDataReportForUser | 查询个人事件统计数据 | 查询个人事件统计数据。 |
ListChartDataForUser | 数据报表图表数据接口(人员) | 数据报表图表数据接口(人员)。 |
GeneratePictureLink | 生成图片链接 | 生成图片链接 |
RemoveIntegrationConfig | 解除集成配置 | 解除集成配置 |
ListByMonitorSourceId | 监控关联规则列表 | 监控关联规则列表 |
ListRouteRulesByService | 根据服务id查询流转规则 | 根据服务id查询流转规则 |
GetTenantStatus | 查询租户开通运维事件中心的状态 | 查询租户开通运维事件中心的状态 |
BillingStatistics | 计费展示 | 计费展示 |
DeleteServiceGroupScheduling | 删除排班 | 删除排班 |
ListEscalationPlansByNoticeObject | 根据推送对象查询升级策略 | 根据推送对象查询升级策略 |
UnbindUser | UnbindUser | 解绑用户 |
ListRouteRulesByAssignWhoId | ListRouteRulesByAssignWhoId | 获取指定分配对象的流转规则 |
ListServiceGroupsByUserId | 根据成员id查服务组 | 根据成员id查服务组 |