AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 运维事件中心 开发参考 API参考 API概览

API概览

更新时间：
产品详情
我的收藏
本产品（运维事件中心/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概述
GeneratePictureUploadSign生成图片上传签名信息生成图片上传签名信息。
ListProblemDetailOperations故障详情动态故障详情动态。
UpdateProblemImprovement更新故障复盘改进详情更新故障复盘改进详情。
ListSubscriptionServiceGroups故障协同组列表故障协同组列表。
CreateProblem故障升级新增故障。
CreateProblemMeasure创建故障改进措施创建故障改进措施。
CreateProblemSubtotal故障新增备注小计故障新增备注小计。
CreateProblemTimeline创建故障时间线节点创建故障时间线节点。
CreateProblemTimelines批量创建时间节点批量创建时间节点。
AddProblemServiceGroup新增故障应急协同组新增故障应急协同组。
UpdateProblem更新故障详情更新故障详情。
UpdateProblemNotice更新故障通告更新故障通告。
UpdateProblemTimeline更新故障时间线更新故障时间线。
GenerateProblemPictureUploadSign故障图片上传获取签名信息故障图片上传获取签名信息。
ListProblemOperations故障动态故障动态列表。
ListProblems查询故障列表查询故障列表。
ListProblemSubtotals故障小计列表故障小计列表。
CancelProblem故障取消故障取消。
FinishProblem故障完结故障完结。
RecoverProblem故障恢复故障恢复。
ReplayProblem故障复盘故障复盘。
RevokeProblemRecovery故障撤销恢复故障撤销恢复 。
GenerateProblemPictureLink获取故障图片链接获取故障图片链接。
UpdateProblemEffectionService更新故障影响服务更新故障影响服务。
DeleteProblemEffectionService删除影响服务删除影响服务。
UpdateProblemMeasure更新故障改进措施更新故障改进措施。
DeleteProblem删除故障删除故障。
GetProblem故障详情故障详情。
GetProblemImprovement故障复盘改进详情故障复盘改进详情 。
DeleteProblemMeasure删除故障改进措施删除故障改进措施。
DeleteProblemTimeline删除故障事件线节点删除故障事件线节点。
ListProblemTimeLines查询故障时间线列表查询故障时间线列表 。
GetProblemEffectionService故障影响服务详情故障影响服务详情。
GetProblemPreview获取故障通知预览获取故障通知预览。
RemoveProblemServiceGroup移除故障应急协同组移除故障应急协同组。
CreateProblemEffectionService创建影响服务创建影响服务。

全局配置

API标题API概述
GetResourceStatistics获取资源统计获取资源统计。
ListConfigs码表配置获取全部动态码表配置项。
ListDictionaries枚举字典接口枚举字典接口。
ListMonitorSources监控源列表监控源列表。

移动应用

API标题API概述
CreateTenantApplication创建移动应用创建移动应用。
GetTenantApplication移动应用详情移动应用详情。

业务监控

API标题API概述
PushMonitorAPI集成业务监控数据推送,业务监控数据保存。

升级计划

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根据推送对象查询升级策略根据推送对象查询升级策略
UnbindUserUnbindUser解绑用户
ListRouteRulesByAssignWhoIdListRouteRulesByAssignWhoId获取指定分配对象的流转规则
ListServiceGroupsByUserId根据成员id查服务组根据成员id查服务组
上一篇：API参考下一篇：服务接入点