KPI 异常检测模型服务 - HUAWEI CLOUD · 2020. 7. 12. · kpi数量的计算方法为：kpi数量 = 单节点kpi数量 * 节点数量。计费公式为：单位价格 * kpi步长数量

NAIEV200R021C30

KPI 异常检测模型服务

文档版本 01

发布日期 2020-12-30

华为技术有限公司

版权所有 © 华为技术有限公司 2021。保留一切权利。

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。商标声明

和其他华为商标均为华为技术有限公司的商标。本文档提及的其他所有商标或注册商标，由各自的所有人拥有。注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或默示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

文档版本 01 (2020-12-30) 版权所有 © 华为技术有限公司 i

目录

1 文档导读......................................................................................................................................1

2 产品介绍......................................................................................................................................22.1 什么是 KPI 异常检测模型服务...............................................................................................................................................22.2 应用场景......................................................................................................................................................................................22.3 产品功能......................................................................................................................................................................................22.4 产品价值......................................................................................................................................................................................32.5 约束限制......................................................................................................................................................................................32.6 基本概念......................................................................................................................................................................................52.7 与其他服务的关系.................................................................................................................................................................... 52.8 计费说明......................................................................................................................................................................................62.9 访问 KPI 异常检测模型服务................................................................................................................................................... 72.10 修订记录................................................................................................................................................................................... 7

3 快速入门......................................................................................................................................83.1 KPI 异常检测模型服务操作指导........................................................................................................................................... 83.1.1 前提条件.................................................................................................................................................................................. 83.1.2 订购 KPI 异常检测模型服务................................................................................................................................................83.1.3 访问 KPI 异常检测模型服务................................................................................................................................................93.1.4 操作流程.................................................................................................................................................................................. 93.1.5 检测对象配置....................................................................................................................................................................... 103.1.5.1 KPI 属性配置..................................................................................................................................................................... 103.1.5.2 时序数据导入....................................................................................................................................................................143.1.6 高级配置................................................................................................................................................................................ 153.1.6.1 检测策略............................................................................................................................................................................ 153.1.6.2 事件管理............................................................................................................................................................................ 173.1.6.3 任务管理............................................................................................................................................................................ 183.1.7 异常看板................................................................................................................................................................................ 193.1.7.1 可视化看板........................................................................................................................................................................ 193.1.7.2 异常列表............................................................................................................................................................................ 213.2 修订记录................................................................................................................................................................................... 23

4 API 参考.................................................................................................................................... 244.1 使用前必读............................................................................................................................................................................... 244.2 接口简介................................................................................................................................................................................... 24

NAIEKPI 异常检测模型服务目录

文档版本 01 (2020-12-30) 版权所有 © 华为技术有限公司 ii

4.3 环境准备................................................................................................................................................................................... 264.3.1 获取请求认证....................................................................................................................................................................... 264.3.2 获取项目 ID/租户 ID.......................................................................................................................................................... 274.4 接口使用方法...........................................................................................................................................................................274.5 数据配置................................................................................................................................................................................... 304.5.1 查询导入文件....................................................................................................................................................................... 304.5.2 查询文件中的数据详情...................................................................................................................................................... 314.5.3 下载导入模板....................................................................................................................................................................... 334.5.4 导入数据................................................................................................................................................................................ 344.6 KPI 属性配置............................................................................................................................................................................ 354.6.1 修改 KPI 属性....................................................................................................................................................................... 354.6.2 删除 KPI 属性....................................................................................................................................................................... 374.6.3 查询 KPI 属性....................................................................................................................................................................... 384.6.4 下载导入摸板....................................................................................................................................................................... 394.6.5 批量导入 KPI 指标...............................................................................................................................................................404.7 事件信息配置...........................................................................................................................................................................414.7.1 新增事件信息....................................................................................................................................................................... 414.7.2 修改事件信息....................................................................................................................................................................... 424.7.3 删除事件信息....................................................................................................................................................................... 444.7.4 查询事件信息....................................................................................................................................................................... 444.8 检测参数配置...........................................................................................................................................................................464.8.1 查询系统参数....................................................................................................................................................................... 464.8.2 修改系统参数....................................................................................................................................................................... 484.9 任务管理................................................................................................................................................................................... 494.9.1 查询任务信息....................................................................................................................................................................... 504.9.2 启动任务................................................................................................................................................................................ 524.9.3 停止任务................................................................................................................................................................................ 534.10 异常结果................................................................................................................................................................................. 544.10.1 查询异常信息.....................................................................................................................................................................544.10.2 异常信息反馈.....................................................................................................................................................................564.10.3 批量导出异常信息............................................................................................................................................................ 574.10.4 删除异常信息.....................................................................................................................................................................594.11 可视化看板............................................................................................................................................................................ 604.11.1 查询 KPI 检测相关数据总数........................................................................................................................................... 604.11.2 查询 KPI ID 信息............................................................................................................................................................... 614.11.3 查询 KPI 检测数据............................................................................................................................................................ 654.11.4 新增定制视图.....................................................................................................................................................................674.11.5 删除定制视图.....................................................................................................................................................................674.11.6 获取图表信息.....................................................................................................................................................................684.11.7 新增图表............................................................................................................................................................................. 694.11.8 修改图表............................................................................................................................................................................. 704.11.9 删除图表............................................................................................................................................................................. 72


文档版本 01 (2020-12-30) 版权所有 © 华为技术有限公司 iii

4.12 公共参数................................................................................................................................................................................. 734.12.1 通用请求返回值................................................................................................................................................................ 734.12.2 错误码说明......................................................................................................................................................................... 734.13 修订记录................................................................................................................................................................................. 76

5 常见问题....................................................................................................................................775.1 KPI 异常检测的业务场景有哪些？.....................................................................................................................................775.2 KPI 异常检测是否可以解决所有异常场景？................................................................................................................... 775.3 KPI 数据分类一般有哪些？..................................................................................................................................................775.4 修订记录................................................................................................................................................................................... 77

6 产品术语....................................................................................................................................78


文档版本 01 (2020-12-30) 版权所有 © 华为技术有限公司 iv

1 文档导读

KPI异常检测模型服务提供了产品介绍、快速入门、常见问题和产品术语手册，帮助用户快速熟悉和使用KPI异常检测模型服务，生成局点定制模型。

表 1-1 文档导读

手册概述

《产品介绍》本文档详细阐述了KPI异常检测模型服务的定位、应用场景、功能、价值与约束限制等。

《快速入门》本文档介绍如何使用KPI异常检测模型服务，快速生成KPI异常检测模型，实现用户快速熟悉和使用KPI异常检测模型服务。

《常见问题》本文档收集了用户日常使用KPI异常检测模型服务遇到的问题，并给予解答，有助于快速解答用户问题。

《产品术语》本文档详细阐释KPI异常检测模型服务相关的产品术语。

《API参考》本文档包含了KPI异常检测模型服务的API描述、语法、参数说明及样例等内容。

NAIEKPI 异常检测模型服务 1 文档导读

文档版本 01 (2020-12-30) 版权所有 © 华为技术有限公司 1

2 产品介绍

2.1 什么是 KPI 异常检测模型服务KPI异常检测服务是从大量的KPI输入数据中精准高效的识别出KPI异常数据的服务，该服务根据用户的业务配置和数据类型识别输入KPI的模式，并自动进行算法调优，帮助预判系统故障或在故障发生时帮助快速定位问题。

2.2 应用场景

掉话率检测

掉话率是电信领域核心网的关键指标，传统基于固定阈值告警的模式无法识别指标正常波动，不能预测指标恶化。通过使用KPI异常检测服务，可快速实现指标趋势预测，智能识别异常并告警。

呼叫质量检测

通信运营商呼叫中心KPI，有助实现优质的目标管理。对呼叫总数、呼叫放弃率等KPI进行监控，及时发现话务突增突降现象。

网站 KPI 检测

通信运营商在线商城网站KPI，是衡量网站质量和表现的指标。对用户数、广告点击量、页面流量等KPI的监控，可以及时发现特定因素对网站的影响，和网站的更改或变动。

2.3 产品功能

智能异常检测

提供API 接口，对时间序列进行检测，支持如下检测类型：离散、白噪声、周期、周期+趋势、周期+变点、不规则周期。

NAIEKPI 异常检测模型服务 2 产品介绍


自动建模

根据输入的数据流，服务自动生成匹配业务的算法模型。

标注打标

提供标注打标的功能，标记/取消标记为正负样本，标记后样本入样本库。

样本管理

提供时序数据样本管理功能，存储的长度用户可控。

2.4 产品价值

适用领域广泛

服务支持多种KPI模式（如周期、突变、趋势等)，适用于电信行业多领域的KPI异常检测，例如 VOLTE核心网、EPC核心网、无线接入网等。

异常定位精确

内嵌GMM、xgboost 、Holt-Winters等多种智能算法，根据用户数据特征自动调优，KPI异常检测准确率高达95%。

运行高效率，易集成

KPI异常检测服务支持云化部署，性能支持弹性伸缩，按需分配系统资源，大支持10万+KPI同时检测，实现毫秒级异常检测，通过支持RESTful规范的API接口，可大幅降低集成难度，实现业务快速上线。

2.5 约束限制1. 时序数据连续，数据缺失率<10%。

2. 周期数据至少要提供4个周期的数据，非周期数据建议历史一周数据。

3. 多KPI关联检测，采集点必须一致。

4. 支持的时序波形类型，包括：

– 离散数据类型



– 白噪声

– 周期数据

– 周期+趋势数据

– 周期+跳变数据



– 不规则周期数据

2.6 基本概念

API

全称Application Programming Interface。应用软件编程接口，即一些预先定义的函数，目的是提供应用程序，使得开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码或理解内部工作机制的细节。

KPI

全称：Key Performance Indicator。关键性能指数，代表某对象某一时刻的性能值。KPI也可能由多级KPI汇聚而来。

2.7 与其他服务的关系

与 ModelArts 服务的关系

NAIE平台使用，华为公有云系统提供的ModelArts服务，实现数据预处理、大规模分布式模型训练能力。



与统一身份认证服务 IAM 的关系

NAIE平台使用，华为公有云系统提供的统一身份认证服务（Identity and AccessManagement，简称IAM），实现统一的身份认证和权限管理服务。

与 API 网关的关系

NAIE平台必须对接到华为公有云系统提供的统一API网关，此API网关为用户提供统一的入口调用NAIE云服务的API。NAIE云服务开放给租户的API，必须在API网关上注册通过后再发布。

与对象存储服务的关系

NAIE平台使用对象存储服务（Object Storage Service，简称OBS）存储数据和模型的备份和快照，实现安全、高可靠和低成本的存储需求。

与云容器引擎的关系

NAIE平台使用云容器引擎（Cloud Container Engine，简称CCE）部署模型为在线服务。支持服务的高并发和弹性伸缩需求。

2.8 计费说明

计费项

KPI异常检测模型服务按照订购服务时，设置的KPI数量和服务订购时长进行计费。计费项包括：KPI数量，如表2-1所示。

表 2-1 计费项

计费项计费说明

KPI数量 KPI异常检测模型服务根据订购时设置的KPI数量和服务订购时长进行计费。

服务订购后开始计费，不使用请及时退订服务，以免产生不必要的费用。

计费模式

按需计费方式，即按服务订购时设置的KPI数量和服务订购时长计费。

KPI数量的计算方法为：KPI数量 = 单节点KPI数量 * 节点数量。

计费公式为：单位价格 * KPI步长数量 * 服务订购时长。计费步长为1000个KPI。

变更配置

订购KPI异常检测模型服务后，开始计费。用户根据实际情况退订或者重新订购服务，不涉及服务变更配置。



续费

用户可以根据实际使用情况，及时充值。保证可以正常使用KPI异常检测模型服务。

到期与欠费

如果没有按时续费，云平台会提供一定的宽限期和保留期，详情请参见“宽限期保留期”。

保留期满仍未充值，则系统会清空资源。

2.9 访问 KPI 异常检测模型服务步骤1 在用户终端PC上打开浏览器，在地址栏中输入“https://console-

intl.huaweicloud.com/naie/”，进入NAIE服务官网。

步骤2 单击界面右上角的“登录”，进入登录界面。

步骤3 选择“IAM用户登录”方式，输入租户名、用户名和密码。

用户也可以直接通过账号登录。首次登录后请及时修改密码，并定期修改密码。

步骤4 单击“登录”，进入NAIE服务官网。

步骤5 依次选择“AI服务 > 模型与训练服务 > 通信模型服务 > KPI异常检测模型服务”，进入KPI异常检测模型服务介绍页面。

步骤6 单击“进入服务”，进入KPI异常检测模型服务页面。

----结束

2.10 修订记录

发布日期修订记录

2020-06-30 新增“计费说明”章节。

2019-12-30 《产品介绍》大纲优化，资料全部重新写作。

2019-04-30 第一次正式发布。



https://support.huaweicloud.com/intl/zh-cn/usermanual-billing/zh-cn_topic_0083039587.html

https://support.huaweicloud.com/intl/zh-cn/usermanual-billing/zh-cn_topic_0083039587.html

https://console-intl.huaweicloud.com/naie/


3 快速入门

3.1 KPI 异常检测模型服务操作指导

3.1.1 前提条件

● 已经注册华为云账号。

● 已经注册NAIE平台的管理员租户和IAM用户。

● 已经订购过NAIEKPI异常检测模型服务。

3.1.2 订购 KPI 异常检测模型服务

步骤1 在用户终端PC上打开浏览器，在地址栏中输入“https://console-intl.huaweicloud.com/naie/”，进入NAIE服务官网。

用户首次访问NAIE服务官网，会进入“访问授权”界面，单击“授权并继续”即可。


步骤3 输入租户名和密码，单击“登录”，进入NAIE服务官网。

首次登录后请及时修改密码，并定期修改密码。


步骤5 单击“我要购买”，进入如图3-1所示的界面。

用户可以单击“了解计费详情”，详细了解KPI异常检测模型服务提供的资源、规格和相应的价格信息。同时，用户在使用具体资源时，服务会在界面给出醒目的计费提示。

参数说明如下所示：

● 区域：为用户提供服务的华为云Region。

● KPI指标数量：待检测的KPI指标数量，请根据现网实际情况配置。

NAIEKPI 异常检测模型服务 3 快速入门




图 3-1 订购 KPI 异常检测模型服务

步骤6 单击“立即使用”，服务订购完成。

----结束

3.1.3 访问 KPI 异常检测模型服务

步骤1 在用户终端PC上打开浏览器，在地址栏中输入“https://console-intl.huaweicloud.com/naie/”，进入NAIE服务官网。


步骤3 选择“IAM用户登录”方式，输入租户名、用户名和密码。

用户也可以直接通过账号登录。首次登录后请及时修改密码，并定期修改密码。

步骤4 单击“登录”，进入NAIE服务官网。


步骤6 单击“进入服务”，进入KPI异常检测模型服务页面。

----结束

3.1.4 操作流程KPI异常检测模型服务操作流程如操作流程所示。





图 3-2 操作流程

3.1.5 检测对象配置配置待检测网络或系统的KPI属性，并导入对应的时序数据。

3.1.5.1 KPI 属性配置

在进行KPI异常检测之前，用户需要先配置需要检测的KPI指标，系统会对配置的KPI指标进行检测。系统支持批量导入多个KPI指标。



批量导入 KPI 指标

步骤1 在菜单栏中，选择“检测对象配置 > KPI属性配置”，进入“KPI属性配置”页面，如图3-3所示。

图 3-3 KPI 属性配置

步骤2 单击“批量导入”，进入批量导入KPI属性页面，如图3-4所示。

图 3-4 批量导入数据

步骤3 单击“下载导入模板”，下载导入文件。

步骤4 单击图标，从本地选择模板文件，单击“确定”，完成KPI指标的批量导入。

系统提示“导入成功”。

----结束

修改 KPI 指标

步骤1 在菜单栏中，选择“检测对象配置 > KPI属性配置”，进入“KPI属性配置”页面，如图3-5所示。



图 3-5 KPI 属性配置

步骤2 选中KPI指标，单击“修改”，弹出“修改指标”界面，如图3-6所示。

图 3-6 修改页面

参数说明如表3-1所示。

表 3-1 设置参数

参数名称参数说明

检测指标ID KPI指标ID。导入模板文件中指定，导入后不支持修改。

示例：4_117491624。

指标名称 KPI指标名称。

示例：USN_kpi7_sample_ratio。




KPI类型 KPI指标的类型。

包含如下选项：

● ratio：比率

● failureratio：失败率

● attemps：请求次数

● success：成功次数

● failure：失败次数

分组根据业务需求，可以将不同的KPI指标加入到相同分组中。

请根据实际情况设置。

网元类型 KPI指标所在网元的类型。

网元ID KPI指标所在网元的ID。

检测类别系统检测的KPI指标类别。

导入模板文件中指定，导入后不支持修改。


● 不区分，均检测

● 日常检测：日常运行时进行检测

● 重大操作检测：升级或割接时进行检测

检测方向 KPI指标是有取值范围和阈值的，需要根据KPI指标波形变化的趋势进行检测，超出阈值的被标注为异常点。

取值如下所示：

● UP：波形趋势朝上变化时进行检测，如果超出KPI指标的大阈值时，标注为异常点

● DOWN：波形趋势朝下变化时进行检测，如果低于KPI指标的小阈值时，标注为异常点。

● BOTH：不区分，均进行检测。超出小阈值和大阈值时，均会被标注为异常点。

例如：某KPI指标为“打电话被接听的成功率”，如果设置为“DOWN”，当此KPI指标值小于小阈值时，被标注为异常点。

灵敏度检测KPI指标的灵敏度。

取值范围为[1,10]。示例：3。




静态阈值参数

设置KPI指标的静态阈值，KPI指标观察值超过阈值会触发告警。

● 检测类型：KPI指标阈值的来源。包含选项“AI”、“静态阈值”、“AI+静态阈值（并行跑，取并集）”。

● 大值：静态阈值的大值。

● 小值：静态阈值的小值。

● 偏移量：静态阈值的偏移量。

示例说明：如果检测类型为“静态阈值”，大值为“90”，偏移量为“1”，则KPI指标超过“91”时会触发告警。

步骤3 单击“确定”，KPI指标的属性修改完成。

----结束

KPI 属性配置的其他操作● 根据指标ID、分组或指标名称，快速查询对应的KPI指标。

● 选中KPI指标，单击“删除”，删除该KPI指标。

● 选中KPI指标，单击“修改”，修改该KPI指标信息。

3.1.5.2 时序数据导入

步骤1 在菜单栏中，选择“检测对象配置 > 时序数据导入”，进入“时序数据导入”页面，如图3-7所示。

“数据源信息”下方，默认展示已导入平台的数据集列表和数据源类型、文件名称、

数据总数等信息。用户还可以在“操作”列中分别单击、图标，查看数据集的详细信息或删除当前数据集。

图 3-7 时序数据导入界面

步骤2 单击“新增”，进入数据源信息页面，如图3-8所示。

图 3-8 导入数据



步骤3 单击“下载导入模板”，将数据集导入模板下载到本地。

步骤4 配置数据集来源为“本地上传”，在“请选择文件”中，单击图标，从本地导入已下载的模板文件。

步骤5 单击“数据导入”，导入模板文件。

----结束

3.1.6 高级配置根据现网环境需要，配置检测策略、事件和检测任务。

3.1.6.1 检测策略

步骤1 在菜单栏中，单击“高级配置 > 检测策略”，进入“系统参数配置”页面，如图3-9所示。

图 3-9 系统参数配置

配置检测参数如表3-2所示。

表 3-2 检测参数信息

区域参数名称参数说明

训练参数训练任务启动时间间隔(s)

训练任务启动的间隔时间。

示例：30，含义为每30秒启动一次。仅支持输入整数。

首次训练开始时间

基于导入的数据源，设置首次训练的开始时间。训练开始时间晚可以设置为时序数据早开始时间。

默认值：2019/01/01 00:00:00。

检测参数检测任务启动时间间隔(s)

检测任务启动的间隔时间。

默认值：20，含义为每20秒启动一次。



区域参数名称参数说明

首次检测开始时间

基于导入的数据源，设置首次检测的开始时间。检测开始时间早可以设置为时序数据早开始时间后的第八天。

默认值：2019/01/01 00:00:00。

遗失数据百分比

数据缺失的阈值，当数据缺失超过此值时，不执行检测。

默认值：20。仅支持0~100之间的数字。

检测类型 KPI指标阈值的来源。


● AI● 静态阈值

● AI+静态阈值（并行跑，取并集）

默认值：AI

连续异常点上报

连续上报异常点数量阈值(个)

异常点连续时，超过此阈值时，会上报告警。

默认值：3。仅支持输入整数。

非连续异常点上报策略

抖动观测窗口

用于判断震荡非连续异常窗口的长度，例如可以为50个点长度，默认值50（仅支持输入整数）

非连续异常上报百分比(%)

当震荡非连续异常窗口内，异常点数占比超过设定值时，要上报告警，默认值70（仅支持输入 0 到 100 之间的数字）

数据缺失上报策略

数据缺失上报

数据缺失是否上报告警。

包含如下取值：

● 是

● 否

默认值：是

公共参数数据保留时长

配置历史时序数据的保留时长，保留(下次需要检测的时间点减去数据保留时长)时间之后的数据。

默认值：空，表示保留30天。

看板默认时间显示

看板默认显示波形时间段。

默认值：1 （天）

步骤2 单击“保存”，保存检测参数配置。

系统提示“保存成功”。

----结束



3.1.6.2 事件管理

系统检测KPI指标时，如果检测出异常，会关联出事件信息，供用户辅助判断。例如在时间段“2019/08/11 22:00:00~2019/08/12 04:00:00”进行割接，网络出现异常均为正常现象，无须做特殊处理。

新增事件

步骤1 在菜单栏中，选择“高级配置> 事件管理”，进入“事件管理”页面，如图3-10所示。

界面展示事件列表和事件的ID、名称、类型、开始时间和结束时间等信息。

图 3-10 事件管理界面

步骤2 单击“新增”。弹出“新增事件”对话框，如图3-11所示。

图 3-11 新增事件

参数说明如表3-3所示。



表 3-3 新增事件

参数参数说明

事件ID 事件的唯一标识。

事件名称

事件的名称。

示例：春节。

事件类型

事件的类型。


● 灰度升级

● 普通升级

● 打补丁

● 实例化升级

● 割接

● 节假日

● 社会/自然事件

网元ID 网元节点

网元类型

网元类型

开始时间

事件的开始时间。

结束时间

事件的结束时间。

步骤3 单击“确定”，新增事件。

----结束

事件信息配置的其他操作● 根据事件ID、事件名称或事件类型，快速查询对应的事件。

● 选中事件，单击“删除”，删除该事件。

● 选中事件，单击“修改”，修改该事件的配置信息。

3.1.6.3 任务管理

系统默认在KPI属性配置（KPI属性配置）完成后，开始执行KPI异常检测任务。

任务管理中可以查看KPI异常检测任务列表，如任务管理页面所示。



图 3-12 任务管理页面

任务列表主要字段说明如下所示：

● 任务名称：系统根据KPI指标的分组信息自定义。

● 网元ID：网元节点

● 网元类型：网元类型

● 检测指标ID：分组中包含的所有KPI指标。

● 任务状态：任务当前的状态，包括：检测中、未启动、状态异常和废弃。

支持根据任务名称或状态，网元ID或网元类型快速查询检测任务；系统也支持在任务列表的“操作”列，停止或启动检测任务。

3.1.7 异常看板

3.1.7.1 可视化看板

可视化看板以图表的形式显示指定KPI指标，在指定时间段中的波形。

查看默认视图 KPI 信息

以查看默认视图的KPI指标分组“10000001_USN_USN_1000_15,USN_kpi1_sample_ratio&10000002_USN_USN_1000_15,USN_kpi1_sample_attempts&10000003_USN_USN_1000_15,USN_kpi1_sample_failure”为例，操作如下：

步骤1 在菜单栏中，选择“异常看板 > 可视化看板”，进入“可视化看板”界面。

在“可视化看板”界面顶部可以看到指标的订购信息，如图3-13所示。

图 3-13 订购信息

步骤2 在左侧导航栏中，选择“EPC(multi) > USN > USN_1000 >10000001_USN_USN_1000_15,USN_kpi1_sample_ratio&10000002_USN_USN_1000_15,USN_kpi1_sample_attempts&10000003_USN_USN_1000_15,USN_kpi1_sample_failure”。

步骤3 在界面右侧时间段区域框中，配置待检测数据时间区间，例如：“2019/08/0700:00:00 - 2019/08/30 00:00:00”，单击“确定”。刷新时间保持默认值“30s”。



步骤4 单击图标，查看对应的波形，如图3-14所示。

图 3-14 可视化看板

----结束

新增视图

步骤1 在菜单栏中，选择“异常看板 > 可视化看板”，进入“可视化看板”界面。

步骤2 单击界面右上角的“新增视图”，弹出“新增视图”对话框。

步骤3 配置视图名称为“USN0000145”，单击“确定”。

进入“USN0000145”视图页面。

步骤4 单击“ ”。弹出“创建图表”对话框，如图3-15所示。

参数设置如下所示：

● 图表名称：设置为“USN0000145”。

● 选择指标：从“选择指标”框中选择KPI指标分组左侧的复选框，单击图标，添加至右侧的“已选指标”框中。

● 图表显示布局：请根据实际情况选择。



图 3-15 创建图表

步骤5 单击“确定”。

新增“USN0000145”图表，返回“USN0000145”视图页面。

步骤6 在右侧区域框中配置时间段为“2019/08/07 00:00:00 - 2019/08/30 00:00:00”，单击

“确定”，刷新时间保持默认值“30s”。单击图标查看对应的波形。如图3-16所示。

图 3-16 USN0000145 图表

----结束

3.1.7.2 异常列表

异常列表中展示系统当前检测出的异常KPI详细信息，如图3-17所示。

系统支持根据异常ID、检测指标ID和异常状态，快速查询异常检测结果。支持批量导出检测结果。



图 3-17 KPI 检测异常结果

用户对异常结果进行反馈、删除异常记录操作步骤如下所示。

步骤1 在菜单栏中，选择“异常看板 > 异常列表”。

步骤2 在“异常列表”界面，单击异常ID对应“操作”列的图标。

进入异常结果反馈页面，如图3-18所示。红色代表KPI指标异常。

图 3-18 异常反馈

步骤3 根据现网业务，判断此KPI指标是否为异常。

根据实际情况选择“命中”或“误报”及误报类型，同时填写备注信息。

步骤4 单击“反馈”，反馈此KPI指标是否为异常。

步骤5 勾选异常记录前的复选框，单击“删除”，可删除异常信息，支持一次删除多条记录。

说明

若检测指标已删除，则操作列按钮置灰，无法对指标进行反馈操作。

----结束



3.2 修订记录


2020-03-30 新增“订购KPI异常检测模型服务”章节。

KPI异常检测模型服务界面优化，资料全量刷新。

2019-12-30 服务界面改版和功能优化，资料全量更新。

2019-04-30 第一次正式发布。



4 API 参考

4.1 使用前必读本文档主要面向NAIE各服务开发、测试人员，用于指导使用NAIE训练服务API接口完成AI服务订购或管理服务资源。

表 4-1 文档导读

阶段相关链接

了解API接口组成及接口列表

● 使用前必读

使用接口前必做的准备工作

● 环境准备

REST消息体组成以及使用方法

● 接口使用方法

接口使用说明 ● 数据配置

● KPI属性配置

● 事件信息配置

● 检测参数配置

● 任务管理

● 异常结果

● 可视化看板

公共参数公共参数

4.2 接口简介KPI异常检测对外API接口如下表。

NAIEKPI 异常检测模型服务 4 API 参考


类型接口说明

数据配置接口

查询导入文件查询导入的文件

查询文件中的数据详情查询导入文件中的详细数据信息

下载导入模板下载数据模板

上传数据上传数据

KPI属性配置接口

修改KPI属性修改KPI

删除KPI属性删除KPI

查询KPI属性查询KPI

批量导入KPI指标批量导入KPI

事件信息配置接口

新增事件信息新增事件

修改事件信息修改事件

删除事件信息删除事件

查询事件信息查询事件

检测参数配置接口

查询系统参数查询系统配置参数

修改系统参数修改系统参数

任务管理接口

查询任务信息查询任务

启动任务开始任务

停止任务停止任务

异常结果接口

查询异常信息查询异常信息

异常信息反馈异常信息反馈

批量导出异常信息批量导出异常信息

删除异常信息删除异常点相关的信息

可视化看板接口

查询KPI检测相关数据总数查询KPI检测相关数据总数

查询KPI ID信息查询KPIID信息

查询KPI检测数据查询KPI检测数据

新增定制视图新增定制视图

删除定制视图删除定制视图

获取图表信息获取图表信息

新增图表新增图表

修改图表修改图表

删除图表删除图表



4.3 环境准备

4.3.1 获取请求认证

调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。推荐使用AK/SK认证，其安全性比Token认证要高。

Token认证：通过Token认证通用请求。

Token 认证

当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。

步骤1 发送“POST https://IAM的Endpoint/v3/auth/tokens”，获取IAM的Endpoint及消息体中的区域名称，请参见地区和终端节点。

当服务区域名称为“所有”时，选择IAM“华北-北京一”的Endpoint。

请求内容示例如下：

说明

下面示例代码中的斜体字需要替换为实际内容，详情请参考《统一身份认证服务API参考》。

{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "password", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "cn-north-1aaa" //假设项目名称是"cn-north-1aaa" } } } }

步骤2 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

步骤3 调用业务接口，在请求消息头中增加“X-Auth-Token”，“X-Auth-Token”的取值为步骤2中获取的Token。

----结束



http://developer.huaweicloud.com/endpoint.html

4.3.2 获取项目 ID/租户 ID在调用接口的时候，部分URL中需要填入项目ID（project_id或者tenant_id，本文中project_id和tenant_id含义一样），所以需要先在管理控制台上获取到项目ID。项目ID获取步骤如下：

1. 注册并登录管理控制台。

2. 单击用户名，在下拉列表中单击“基本信息”。

3. 在基本信息页面单击“管理我的凭证”。

在“我的凭证”页面的项目列表中查看项目ID。

图 4-1 查看项目 ID

4.4 接口使用方法公有云API符合RESTful API设计理论。REST从资源的角度观察整个网络，分布在各处的资源由URI（Uniform Resource Identifier）确定，客户端的应用通过URL（UnifiedResource Locator）获取资源。URL的一般格式为：https://Endpoint/uri。其中uri为资源路径，也即API访问的路径。

公有云接口采用HTTPS传输协议，请求/响应报文使用JSON报文，媒体类型表示为Application/json。

REST从资源的角度来观察整个网络，提供创建、查询、更新、删掉等方法访问服务的资源。

REST API请求/响应对可以分为五个部分：

● 请求URI

● 请求消息头

● 请求消息体

● 响应消息头

● 响应消息体

请求 URI● URI格式

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}



尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在这单独拿出来强调。

● URI中的参数说明

参数描述

URI-scheme 表示用于传输请求的协议。

Endpoint 指定承载REST服务端点的服务器域名或IP，从地区和终端节点中获取。

resource-path 资源路径，也即API访问路径。从具体接口的URI模块获取，例如“v3/auth/tokens”。

Query string 可选参数，例如API版本或资源选择标准。

请求消息头

请求消息头包含如下两部分。

● HTTP方法（也称为操作），它告诉服务你正在请求什么类型的操作。

表 4-2 HTTP 方法

方法说明

GET 请求服务器返回指定资源。

PUT 请求服务器更新指定资源。

POST 请求服务器新增资源或执行特殊操作。

DELETE 请求服务器删除指定资源，如删除对象等。

HEAD 请求服务器资源头部。

PATCH 请求服务器更新资源的部分内容。

当资源不存在的时候，PATCH可能会去创建一个新的资源。

● 可选的附加请求头字段，如指定的URI和HTTP方法所要求的字段。详细的公共请求消息头字段请参见表4-3，其中请求认证信息请参见获取请求认证。

表 4-3 公共请求消息头

名称描述是否必选示例

Content-Type

消息体的类型（格式）

是 application/json

X-Auth-Token

Token认证信息，通

过Token认证获取。

当使用Token方式认证时，必须填充该字段。

-





名称描述是否必选示例

X-Sdk-Date

请求发送的时间。当使用AK/SK认证时，必须填该字段。

20151222T034042Z

Authorization

签名认证信息该值来源于请求签名结果。

当使用AK/SK认证

时，必须填该字段。

SDK-HMACSHA256Credential=ZIRRKMTWPTQFQI1WKNKB/20151222/cnnorth-1/ec2/sdk_request,SignedHeaders=connection;contenttype;host;x-sdk-date,Signature=7972cc9145876d174b3862188a0f61819431fa71c8a8a060809ea8b898e3eaa9Host:www.myhwclouds.com

请求消息体

请求消息体通常以结构化格式（如JSON）发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。

若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。

响应消息头

响应消息头包含如下两部分。

● 一个HTTP状态代码，从2xx成功代码到4xx或5xx错误代码。或者，可以返回服务定义的状态码，如API文档中所示。

● 附加响应头字段，如支持请求的响应所需，如Content-type响应消息头。详细的公共响应消息头字段请参见表4-4。



表 4-4 响应消息头

名称描述示例

Date HTTPS协议标准报头。表示消息发送的时间，时间的描述格式由rfc822定义。

Mon, 12 Nov 200715:55:01 GMT

Server HTTPS协议标准报头。包含了服务器用来处理请求的软件信息。

Apache

Content-Length

HTTPS协议标准报头。用于指明实体正文的长度，以字节方式存储的十进制数字来表示。

-

Content-Type HTTPS协议标准报头。用于指明发送给接收者的实体正文的媒体类型。

application/json

响应消息体

响应消息体通常以结构化格式（如JSON）返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。

发起请求

共有三种方式可以基于已构建好的请求消息发起请求，分别为：

● cURLcURL是一个命令行工具，用来执行各种URL操作和信息传输。cURL充当的是HTTP客户端，可以发送HTTP请求给服务端，并接收响应消息。cURL适用于接口调试。关于cURL详细信息请参见https://curl.haxx.se/。

● 编码

通过编码调用接口，组装请求消息，并发送处理请求消息。

● REST客户端

Mozilla、Google都为REST提供了图形化的浏览器插件，发送处理请求消息。针对Firefox，请参见FirefoxREST Client。针对Chrome，请参见ChromeRESTClient。

4.5 数据配置

4.5.1 查询导入文件

功能介绍

查询导入的文件。

URIURI格式



https://curl.haxx.se/

https://addons.mozilla.org/en-US/firefox/addon/restclient/

https://code.google.com/archive/p/rest-client

https://code.google.com/archive/p/rest-client

/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/uploadrecords

请求

请求样例GEThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/uploadrecords

响应

成功响应样例{ "res_data": { "result": [ "{'file_name': 'kpi_series_example.csv', 'data_type': '本地上传', 'data_num': '20160', 'file_id': '20200319101250'}" ] }}

返回值

具体请参考通用请求返回值。

4.5.2 查询文件中的数据详情

功能介绍

查询导入文件中的详细数据信息。

URIURI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/uploadrecords

参数说明，如表4-5所示。

表 4-5 参数说明

参数是否必选类型说明

file_name Y String 文件名称

file_id Y String 文件id

请求

请求样例：POSThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/uploadrecords{ "req_data": { "file_name": "kpi_series_example.csv", "file_id": "20200319101250"



}}

响应

成功响应样例：{ "res_data": { "TaskData": [ "{'kpi_id': '10000007_USN_USN_1000_15', 'start_time': '2019-08-01T00:15:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 15, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 2688}", "{'kpi_id': '10000008_USN_USN_1000_15', 'start_time': '2019-08-01T00:15:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 15, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 2688}", "{'kpi_id': '10000009_USN_USN_1000_15', 'start_time': '2019-08-01T00:15:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 15, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 2688}", "{'kpi_id': '10000010_USN_USN_1000_30', 'start_time': '2019-08-01T00:30:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 30, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 1344}", "{'kpi_id': '10000011_USN_USN_1000_30', 'start_time': '2019-08-01T00:30:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 30, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 1344}", "{'kpi_id': '10000012_USN_USN_1000_30', 'start_time': '2019-08-01T00:30:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 30, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 1344}", "{'kpi_id': '10000013_USN_USN_1000_30', 'start_time': '2019-08-01T00:30:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 30, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 1344}", "{'kpi_id': '10000014_USN_USN_1000_30', 'start_time': '2019-08-01T00:30:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 30, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 1344}", "{'kpi_id': '10000015_USN_USN_1000_30', 'start_time': '2019-08-01T00:30:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 30, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 1344}", "{'kpi_id': '10000016_USN_USN_1000_30', 'start_time': '2019-08-01T00:30:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 30, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 1344}",



"{'kpi_id': '10000017_USN_USN_1000_30', 'start_time': '2019-08-01T00:30:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 30, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 1344}", "{'kpi_id': '10000018_USN_USN_1000_30', 'start_time': '2019-08-01T00:30:00', 'end_time': '2019-08-29T00:00:00', 'sampling_period': 30, 'kpi_list': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15', '10000010_USN_USN_1000_30', '10000011_USN_USN_1000_30', '10000012_USN_USN_1000_30', '10000013_USN_USN_1000_30', '10000014_USN_USN_1000_30', '10000015_USN_USN_1000_30', '10000016_USN_USN_1000_30', '10000017_USN_USN_1000_30', '10000018_USN_USN_1000_30'], 'kpi_num': 1344}" ], "file_message": { "accomplish_number": 20160, "end_time": "2019-08-29T00:00:00", "failed_number": "0", "file_path": "kpi_series_example.csv", "start_time": "2019-08-01T00:15:00", "total_number": 20160 }, "result": { "code": 0, "msg": "success" } }}

返回值


4.5.3 下载导入模板

功能介绍

下载用户上传数据的模板文件。

URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/download?tag=kpi_node_example.cs




tag Y String 模板文件名称

请求

请求样例：GEThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/download?tag=kpi_node_example.csv



响应

调用当前接口，返回模板文件。

返回值


4.5.4 导入数据

功能介绍

将编辑好的数据文件导入到数据库中。

URIURI格式/rest/common/service/obs/v1.0/file/upload




obsFile Y - 公有云文件上传

请求

请求样例：POSThttps://console.ulanqab.huawei.com/domainconsole/rest/common/service/obs/v1.0/file/upload{ obsFile: (binary）}




obsFile Y binary 公有云文件上传

响应

成功响应样例：{ "error_list" : [], "existed_list" : [], "fail_num" : "0", "file_id" : "20200422150451", "file_name" : "kpi_series_all.csv",



"kpi_list" : ["10_117502021", "5_128974850", "4_117491624", "9_U12", "8_117502425", "8_U16", "5_U4", "6_117502425", "2_128974884", "2_117499712", "2_U20", "6_117502413", "13_U11", "8_U21", "8_128974885", "5_U5", "8_117499752", "6_U16", "9_U11", "13_128974878", "13_U12", "10_U15", "8_117502413", "9_128974878", "10_117502013", "6_117491624"], "message" : "file upload success!", "success_num" : "47040"}

返回值


4.6 KPI 属性配置

4.6.1 修改 KPI 属性

功能介绍

对已经增加的KPI属性进行修改。

URI

URI格式rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/properties




KPIID Y String KPI标识

KPIGroupID Y String KPI组标识

nodeID Y String 节点标识

nodeTypeID Y String 节点类型标识

instanceTypeID Y String 服务实例类型标识

instanceID Y String 服务实例标识

display Y String 显示名称

detectObject Y integer 检测类型

direction Y String 波形方向，枚举类型

maxThreshold Y integer 静态阈值大值

minThreshold Y integer 静态阈值小值

priority Y integer 优先级

sensitivity Y integer 敏感度




detectType Y integer 检测类型

offsetValue Y integer 静态阈值偏移量

type Y String KPI类型

请求

请求样例：POSThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/properties{ "req_data": { "KPIList": [ { "KPIID": "10000007_USN_USN_1000_15", "BasicProperties": { "KPIGroupID": "USN0000003_USN_USN_1000_15", "nodeID": "USN", "nodeTypeID": "EPC_Sample", "instanceTypeID": "", "instanceID": "USN_1000", "display": "USN_kpi3_sample_ratio", "detectObject": 1 }, "detectParam": { "direction": "DOWN", "maxThreshold": 1, "minThreshold": 1, "priority": 0, "sensitivity": 5, "detectType": 1, "offsetValue": 1, "type": "ratio" } } ] }}

响应

成功响应样例：{ "res_data": { "result": { "code": 0, "msg": "success!" } }}

返回值




4.6.2 删除 KPI 属性

功能介绍

对已经增加的KPI属性进行删除。

URI

URI格式rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/properties




KPIList Y Arrary 多个KPI指标的ID列表

groupList Y Arrary 多个KPI指标所在组名列表

deleteType Y integer 删除方式，包含软删除和实际删除两种方式。

请求

请求样例：DELETEhttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/properties{ "req_data": { "KPIList": [], "groupList": [ "USN0000003_USN_USN_1000_15" ], "deleteType": 1 }}

响应


返回值




4.6.3 查询 KPI 属性

功能介绍

查询已增加的KPI指标信息。

URIURI格式rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/properties




operationType Y integer 操作类型

取值为“0”，表示查询KPI属性。

KPIList Y Array 多个KPI指标的ID列表

numberPerPage Y integer 每页所包含的记录数

curPage Y integer 查询的页

kpiName Y String 模糊查询KPI指标名称

kpiGroupId Y String 模糊查询KPI指标分组

kpiNodeId N String 网元ID，模糊查询

kpiNodeType N String 网元类型，模糊查询

请求

请求样例：POSThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/properties{ "req_data": { "operationType": 0, "KPIList": [], "numberPerPage": 10, "curPage": 1, "kpiName": "", "kpiGroupId": "", "kpiNodeId": "", "kpiNodeType": "" }} //分页查询的方式{ "req_data": { "operationType": 0, "KPIList": [], "numberPerPage": 10,



"curPage": 1, "kpiName": "kpi4", "kpiGroupId": "", "kpiNodeId": "USN", "kpiNodeType": "" }} //模糊查询的方式

响应

成功响应样例：{ "res_data": { "KPIData": [ { "KPIID": "10000017_USN_USN_1000_30", "KPIProperties": { "KPIGroupID": "USN0000006_USN_USN_1000_30", "KPIOrgID": null, "KPIUnit": 1, "detectObject": 1, "display": "USN_kpi6_sample_attempts", "instanceID": "USN_1000", "instanceTypeID": null, "nodeID": "USN", "nodeTypeID": "EPC_Sample" }, "detectParam": { "absoluteDeviation": null, "alarmMissData": null, "base_deviation": 0.15, "detectType": null, "direction": "BOTH", "jump_extreme": null, "maxThreshold": null, "minThreshold": null, "normal_filter": null, "numofConAnomaly": null, "offsetValue": null, "priority": 0, "relativeDeviation": null, "sensitivity": 5, "significantDegree": null, "type": "attempts" } } ], "curPage": 1, "result": { "code": 0, "msg": "success!" }, "totalItems": 1, "totalPage": 1 }}

返回值


4.6.4 下载导入摸板

功能介绍

下载批量导入KPI指标的模板文件。



URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/download?tag=kpi_node_example.cs




tag Y String 模板文件名称。

包含如下文件名称：

● kpi_node_example.csv：KPI网元信息

● kpi_properties_example.csv：KPI基础信息

● kpi_group_example.csv：KPI分组信息

请求

请求样例：GEThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/download?tag=kpi_node_example.csv

响应

调用当前接口，返回模板文件。

返回值


4.6.5 批量导入 KPI 指标

功能介绍

对已经增加的KPI属性进行修改。

URI

URI格式rest/common/service/obs/v1.0/file/upload






obsFile Y binary 公有云文件上传

请求

请求样例：POSThttps://console.ulanqab.huawei.com/domainconsole/rest/common/service/obs/v1.0/file/upload

响应

成功响应样例：{ "isSuccess": true, "bucketName": "bucket-nph5op45", "folder": "050192088280d5bb1ff2c014e39e83f6/", "fileName": "kpi_properties_example.csv", "endPoint": "obs.cn-north-7.ulanqab.huawei.com"}

返回值


4.7 事件信息配置

4.7.1 新增事件信息

功能介绍

新增事件相关配置信息。

URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/event




eventID Y String Event标识

eventName Y String Event名称

eventType Y integer Event类型




scope Y String 事件影响范围

startTime Y DATE 事件起始时间

endTime Y DATE 事件结束时间

请求

请求样例：POSThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/event{ "req_data": { "operationType": 2, "eventList": [ { "eventID": "test", "eventName": "test", "eventType": 1, "scope": "1", "startTime": "2020-01-08 11:43:32", "endTime": "2020-01-08 11:43:32" } ] }}

响应


返回值


4.7.2 修改事件信息

功能介绍

对已经增加的事件进行修改。

URIURI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/event






eventID Y String Event标识


eventType Y integer Event类型

scope Y String 事件影响范围

startTime Y DATE 事件起始时间

endTime Y DATE 事件结束时间



● 0：查询

● 1：修改

请求

请求样例：PUThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/event{ "req_data": { "operationType": 1, "eventList": [ { "eventID": "test", "eventName": "test123", "eventType": 1, "scope": "1", "startTime": "2020-01-08 11:43:32", "endTime": "2020-01-08 11:43:32" } ] }}

响应


返回值




4.7.3 删除事件信息

功能介绍

对已经增加的事件信息进行删除。

URI

URI格式rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/event




eventList Y Arrary Event ID列表

请求

请求样例：DELETEhttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/event{ "req_data": { "eventList": [ "test" ] }}

响应


返回值


4.7.4 查询事件信息

功能介绍

查询已增加的事件信息。



URIURI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/event




eventIDList N Arrary Event ID列表，如果不含此参数则为查询全部

eventType Y String Event类型





● 0：查询

● 1：修改


请求

请求样例：POSThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/event{ "req_data": { "eventType": null, "numberPerPage": 10, "curPage": 1, "operationType": 0, "eventName": "" }}

响应

成功响应样例：{ "res_data": { "curPage": 1, "eventList": [ { "endTime": "2019-09-29T15:36:28", "eventID": "1001", "eventInfo": null, "eventName": "1200", "eventType": 2, "scope": "1", "startTime": "2019-09-29T15:36:28" }



], "result": { "code": 0, "msg": "success!" }, "totalItems": 1, "totalPages": 1 }}

返回值


4.8 检测参数配置

4.8.1 查询系统参数

功能介绍

查询已经设置的系统参数。

URIURI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/sysparameter




operationType Y integer 查询标识

取值为“0”，表示查询系统参数。

请求

请求样例：POSThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/sysparameter{ "req_data": { "operationType": 0 }}

响应

成功响应样例：{ "res_data": {



"ChangeTrainTaskInterval": "30", "alarmInterval": "3", "alarmMissData": "0", "dataCleanStartUpTime": "01:00:00", "dataKeepDays": "30", "detectBeginTime": "2019-08-10 00:00:00", "detectTaskInterval": "20", "detectType": "0", "lengthofNormalWindow": "50", "lengthofWindow": "50", "missing_data_percent": "20", "numofConAnomaly": "3", "numofConNormal": "3", "preofAnomaly": "70", "preofNormal": "30", "result": { "code": 0, "mig": "success!" }, "sendAlarmInterval": "60", "sendDataInterval": "60", "trainBeginTime": "2019-08-08 00:00:00", "trainTaskInterval": "30", "wait_minutes": "7", "panelDefaultTime" : "1" }}



参数说明

ChangeTrainTaskInterval 改变训练周期

alarmInterval 连续告警周期

alarmMissData 数据缺失或延迟告警

detectBeginTime 首次训练开始时间

detectTaskInterval 训练任务周期

detectType 检测类型

lengthofWindow 窗口长度，即数据条数

missing_data_percent 缺失百分比

numofConAnomaly 连续上报异常点数量阀值

preofAnomaly 非连续异常上报百分比（%）

result 请求结果

sendAlarmInterval alarm通知任务启动周期

sendDataInterval 检测结果通知任务启动周期

trainBeginTime 首次检测开始时间

trainTaskInterval 检测任务周期



参数说明

panelDefaultTime 看板默认显示波形时间段，默认1天

返回值


4.8.2 修改系统参数

功能介绍

对已经增加的系统参数进行修改。

URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/sysparameter




alarmMissData Y integer 数据缺失或延迟告警

detectBeginTime Y date 首次训练开始时间

detectTaskInterval Y integer 训练任务周期

missing_data_percent

Y integer 遗失数据百分比

detectType Y String 检测类型

lengthofWindow N String 窗口长度，即数据条数

numofConAnomaly

Y String 连续上报异常点数量阀值

preofAnomaly Y String 异常百分比（%）

trainBeginTime Y date 首次检测开始时间

trainTaskInterval Y integer 检测任务周期

dataKeepDays Y String 配置历史时序数据的保留时长，保留(下次需要检测的时间点 - 数据保留时长)时间之后的数据，保留时长默认为空，表示保留30天。




panelDefaultTime Y String 看板默认显示波形时间段，默认1天

请求

请求样例：POSThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/sysparameter{ "req_data": { "sysParameter": { "trainTaskInterval": 30, "detectTaskInterval": 20, "missing_data_percent": 20, "detectType": 0 }, "trainParameter": { "trainBeginTime": "2019-01-10 00:00:00" }, "detectParameter": { "detectBeginTime": "2019-01-17 00:00:00" }, "alarmParameter": { "conAnomalyPolicy": { "numofConAnomaly": 3 }, "nonConAnomalyPolicy": { "lengthofWindow": 50, "preofAnomaly": 70 } }, "cleanDataStrategy": { "dataKeepDays": "30" }, "alarmMissData": 0, "panelDefaultTime": "1" }}

响应


返回值


4.9 任务管理



4.9.1 查询任务信息

功能介绍

查询相关任务信息。

URIURI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/task




TaskList Y Arrary 任务列表。如果参数设置为空，表示查询所有任务信息。


operationType Y integer 操作的类型


● 0：模糊查询

● 1：全量查询


请求

请求样例：

POSThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/task{ "req_data": { "startTime": "2018-01-01 00:00:00", "endTime": "2020-01-08 14:11:00", "curPage": 1, "numberPerPage": 10, "operationType": 1 }} //直接查询全量任务信息{ "req_data": { "TaskList": [], "numberPerPage": 10, "operationType": 0, "curPage": 1, "taskName": "USN_kpi1_sample_ratio detect group", "kpiNodeId": "USN", "kpiNodeType": "EPC_Sample" }} // 模糊查询



响应

成功响应样例：{ "res_data": { "TaskData": [ { "KPIGroupID": "USN0000004_USN_USN_1000_30", "KPIID": [ "10000010_USN_USN_1000_30", "10000011_USN_USN_1000_30", "10000012_USN_USN_1000_30" ], "detectDesc": null, "endTime": null, "kpiNodeId": "USN", "kpiNodeType": "EPC_Sample", "latestPredicttime": "2019-08-29T00:30:00", "methodID": "3000", "startTime": "2020-01-07T05:48:56", "taskID": "USN0000004_USN_USN_1000_30", "taskName": "USN_kpi4_sample_ratio detect group", "taskStatus": 1, "trainDesc": { "10000010_USN_USN_1000_30": "2019-08-28 00:30:00", "10000011_USN_USN_1000_30": "2019-08-28 00:30:00", "10000012_USN_USN_1000_30": "2019-08-28 00:30:00" } } ], "curPage": 1, "result": { "code": 0, "msg": "success" }, "totalItems": 1, "totalPages": 1 }}

表 4-22 返回参数说明

参数说明

totalPages 数据总页数

curPage 当前返回页的信息

taskID 任务标识

KPIID KPI标识

kpiNodeId 网元ID

kpiNodeType 网元

KPIGroupID KPI指标分组ID

methodID 算法标识

startTime 开始时间

endTime 结束时间

latestPredicttime 新预测时间



参数说明

trainDesc 训练描述

返回值


4.9.2 启动任务

功能介绍

启动检测任务。






包含如下类型：

● 0：查询

● 1：任务启动或停止

taskID Y String 任务标识

taskStatus Y integer 任务状态

包含如下状态：

● 0：未启动

● 1：检测

● 2：暂停

● 3：废弃（表示任务不再使用）

请求

请求样例：POSThttps://telcloud.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/task{ "req_data": { "TaskList": [



{ "taskID": "USN0000004_USN_USN_1000_30", "taskStatus": 0 } ], "operationType": 1 }}

响应


返回值


4.9.3 停止任务

功能介绍

停止检测任务。







● 0：查询

● 1：任务启动或停止

taskID Y String 任务标识




taskStatus Y integer 任务状态

包含如下状态：

● 0：未启动

● 1：检测

● 2：暂停

● 3：废弃（表示任务不再使用）

请求

请求样例：POSThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/task{ "req_data": { "TaskList": [ { "taskID": "4_117491624", "taskStatus": 1 } ], "operationType": 1 }}

响应


返回值


4.10 异常结果

4.10.1 查询异常信息

功能介绍

查询异常点相关的信息。



URIURI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/alarm

请求

请求样例：posthttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/alarm{ "req_data": { "startTime": "2018-01-01 00:00:00", "endTime": "2020-01-08 14:11:00", "curPage": 1, "numberPerPage": 10, "operationType": 1 }} //直接查询全量异常点信息{ "req_data": { "startTime": "2018-01-01 00:00:00", "endTime": "2019-09-29 16:57:43", "curPage": 1, "numberPerPage": 10, "alarmID": "812", "kpiId": "USN", "labelType": 1, "operationType": 1 }} //模糊查询




startTime Y date 信息查询起始时间

endTime Y date 信息查询结束时间


numberPerPage

Y integer 每页所包含的记录数


取值为“1”，表示查询信息。

alarmID N String 异常ID，模糊查询

kpiId N integer 指标ID，模糊查询

labelType N integer 异常类型，模糊查询

响应

成功响应样例：



{ "res_data": { "alarmInfo": [ { "absoluteDeviation": 44.2222222222222, "alarmDesc": "USN_kpi4_sample_ratio指标发现异常,网元:USN_1000,KPI Group:USN00002310,KPIs:10_117502021&10_117502013&10_U15 ,连续异常数量:3", "alarmID": "201908100000009", "alarmTime": "2019-08-10T14:00:00", "confirmTime": null, "eventName": "", "kpi_list": [ { "kpi_id": "10_117502021", "kpi_name": "USN_kpi4_sample_ratio" }, { "kpi_id": "10_117502013", "kpi_name": "USN_kpi4_sample_attempts" }, { "kpi_id": "10_U15", "kpi_name": "USN_kpi4_sample_failure" } ], "labelReason": null, "labelType": null, "relativeDeviation": 0.507006369426752, "significantDegree": 0, "totalAnomaly": 3 } ], "curPage": 1, "result": { "code": 0, "msg": "success" }, "totalItems": 5, "totalPages": 1 }}

返回值


4.10.2 异常信息反馈

功能介绍

根据异常点的信息，对该异常进行反馈。

URIURI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/alarm






alarmID Y String 异常ID（告警标识）

labelType Y integer 异常类型。


● 0：异常

● 2：命中

alarmTime Y date 告警时间

labelReason Y String 备注信息

请求

请求样例：POSThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/alarm{ "req_data": { "alarmList": [ { "alarmID": "201908100000009", "labelType": 0, "alarmTime": "2019-09-29 17:03:26", "labelReason": "234" } ] }}

响应


返回值


4.10.3 批量导出异常信息

功能介绍

将异常信息导出为一个文件。



URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/alarm

参数说明，如表4-27所示：



startTime Y date 信息查询起始时间

endTime Y date 信息查询结束时间

curPage Y integer 每页所包含的记录数

numberPerPage

Y integer 查询的页

operationType Y integer 操作类型：

1：查询

2：批量导出

alarmID N Array 导出指定的异常信息，此字段不存在时，默认导出全部异常信息。

请求

请求样例： POSThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/alarm{ "req_data": { "startTime": "2018-01-01 00:00:00", "endTime": "2019-09-29 17:03:29", "curPage": 1, "numberPerPage": 10, "operationType": 2, "alarmID": [ "201908200000053" ] }}

响应

调用当前接口，导出Excel文件。excel样例文件内容样例，如图4-2所示。

图 4-2 Excel 文件内容样例



返回值


4.10.4 删除异常信息

功能介绍

删除异常点相关的信息。

URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/alarm

请求

请求样例：DELETEhttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/alarm{ "req_data": { "curPage": 1, "numberPerPage": 10, "alarmID": [ "201908210000054" ] }}





numberPerPage


alarmID Y Array 异常ID

响应

成功响应样例：{ "res_data": { "result": { "code": 0, "msg": "success" } }}



返回值


4.11 可视化看板

4.11.1 查询 KPI 检测相关数据总数

功能介绍

查询待检测的KPI指标数量、待检测的KPI值总数量和检测出的KPI值异常数量。

URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/count

请求

请求样例：GEThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/count

响应

成功响应样例：{ "res_data": { "result": { "abnormal_num": 17, "abnormal_num_0": 0, "abnormal_num_1": 0, "abnormal_num_2": 1, "kpi_num": "12", "last_update_time": "2020-03-18 16:38:49", "remaining_index": "8", "result_num": "15120", "total_index": "20", "used_index": "12" } }}



参数说明

abnormal_num 总异常数

abnormal_num_0 误报异常数

abnormal_num_1 未确认异常数



参数说明

abnormal_num_2 命中异常数

kpi_num KPI指标总数

result_num 检测的KPI值总数

last_update_time 近一次更新时间

remaining_index 剩余可使用指标数

total_index 当前订购KPI指标数

used_index 已使用KPI指标数

返回值


4.11.2 查询 KPI ID 信息

功能介绍

查询出所有的KPI指标信息。

URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/querykpiid



参数是否必选

类型说明

startIndex

Y integer

请求开始的下标

numberPerReq

Y integer

请求的数量

operationType

Y integer

请求的类型。


● 0：默认视图展示

● 1：搜索KPI指标视图

● 2：编辑KPI指标视图或新增KPI指标视图时的页面查询，自动调用查询KPI ID的接口。



参数是否必选

类型说明

param Y Object

dataType：类型(integer)。取值如下所示：

● 0：请求所有的node_type节点

● 1：请求所有的node_id节点

● 2：请求所有的instance_id节点

● 3：请求所有的properties节点

isSingle：类型(string)。是否为单指标。取值为"Y"/"N"。nodeType：请求数据的note_Type节点名称。

nodeId：请求数据的note_id节点名称。

instanceId：请求数据的instanceId节点名称。

请求

请求样例：POSThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/querykpiid

请求参数：

● 请求nodeType参数：{ "req_data": { "startIndex": 0, "numberPerReq": 100, "operationType": 2, "param": { "optType": 0 } }}

● 请求nodeId参数：{ "req_data": { "startIndex": 0, "numberPerReq": 100, "operationType": 0, "param": { "dataType": 1, "isSingle": "N", "nodeType": "EPC_Sample" } }}

● 请求instanceId参数：{ "req_data": { "startIndex": 0, "numberPerReq": 100, "operationType": 0, "param": { "dataType": 2, "isSingle": "N", "nodeType": "EPC_Sample",



"nodeId": "USN" } }}

● 请求properties参数：{ "req_data": { "startIndex": 0, "numberPerReq": 100, "operationType": 0, "param": { "dataType": 3, "isSingle": "N", "nodeType": "EPC_Sample", "nodeId": "USN", "instanceId": "USN_1000" } }}

● 请求properties参数：新增图表和编辑页面查询kpiid{ "req_data": { "startIndex": 0, "numberPerReq": 100, "operationType": 2, "param": { "optType": 0 } }}

响应

成功响应样例：

● 请求nodeType参数{ "res_data": { "result": { "panel_default_time": "1", "remainNum": "-100", "result": [ "EPC_Sample(multi)" ] } }}

● 请求nodeId参数{ "res_data": { "result": { "panel_default_time": "1", "remainNum": "-100", "result": [ "USN" ] } }}

● 请求instanceId参数{ "res_data": { "result": { "panel_default_time": "1",



"remainNum": "-100", "result": [ "USN_1000" ] } }}

● 请求properties参数{ "res_data": { "result": { "panel_default_time": "1", "remainNum": "-97", "result": [ "10000013_USN_USN_1000_30,USN_kpi5_sample_ratio&10000014_USN_USN_1000_30,USN_kpi5_sample_attempts&10000015_USN_USN_1000_30,USN_kpi5_sample_failure", "10000007_USN_USN_1000_15,USN_kpi3_sample_ratio&10000008_USN_USN_1000_15,USN_kpi3_sample_attempts&10000009_USN_USN_1000_15,USN_kpi3_sample_failure", "10000010_USN_USN_1000_30,USN_kpi4_sample_ratio&10000011_USN_USN_1000_30,USN_kpi4_sample_attempts&10000012_USN_USN_1000_30,USN_kpi4_sample_failure", "10000016_USN_USN_1000_30,USN_kpi6_sample_ratio&10000017_USN_USN_1000_30,USN_kpi6_sample_attempts&10000018_USN_USN_1000_30,USN_kpi6_sample_failure" ] } }}

● 新增图表和编辑图标时，页面查询KPI ID{ "res_data": { "result": { "code": 0, "msg": "success", "multi_kpi": [ { "children": [ { "children": [ { "children": [], "label": "USN_1000" } ], "label": "USN" } ], "label": "EPC_Sample (multi)" } ], "panelDefaultTime": "1", "remainNum": "0", "single_kpi": [] } }}



参数说明

panel_default_time 看板默认显示时间段



参数说明

remainNum 剩余可用KPI指标数

result KPI指标视图存放的目录树中各节点的名称

multi_kpi 多KPI指标数据，只在operationType为2时返回

single_kpi 单KPI指标数据，只在operationType为2时返回

返回值


4.11.3 查询 KPI 检测数据

功能介绍

获取KPI指标检测的数据。

URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/data




KPIList Y Arrary KPI指标

startTime Y date 起始时间

endTime Y date 结束时间


numberPerPage


defaultHour Y integer 看板默认显示KPI波形的时间段。若startTime和endTime为空，则defaultHour为系统配置页面设置的看板默认显示时间；如果不为空，则defaultHour为0



请求

请求样例：GEThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/data{ "req_data": [ { "KPIList": [ "4_117491624" ], "startTime": "2019-09-01 00:00:00", "endTime": "2019-09-30 00:00:00", "curPage": 1, "numberPerPage": 100000, "defaultHour": 0 } ]}

响应

成功响应样例：{ "res_data": { "KPIData": [ { "DataList": [ { "collectTime": "2019-08-10T00:00:00", "lowerBound": 62.75, "observedValue": 89, "predictAnomaly": 0, "predictValue": 87.4444444444444, "upperBound": 100 } ], "KPIID": "10_U15", "KPIProperties": { "detect_object": 1, "instanceID": "1000", "instance_type_id": "NaN", "kpi_group_id": "", "kpi_original_id": "110", "kpi_unit": 1, "nodeID": "USN", "nodeTypeID": "EPC" } } ], "result": { "code": 0, "current_page": 1, "mig": "success", "page": 1 } }}

返回值




4.11.4 新增定制视图

功能介绍

增加定制视图模板页面。

URIURI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage




operationType Y integer 操作类型。


● 0：删除

● 2：新增

dyname Y string 视图名称

请求

请求样例：POSThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage{ "req_data": [ { "operationType": "2", "dyname": "测试" } ]}

响应

成功响应样例："import view 测试 success."

返回值


4.11.5 删除定制视图

功能介绍

删除定制视图模板页面。







operationType Y integer 操作类型。


● 0：删除

● 2：新增

dyname Y string 视图名称

请求

请求样例：POSThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage{ "req_data": [ { "dyname": "测试", "operationType": "0" } ]}

响应

成功响应样例：{ "res_data": { "msg": " delete zhk successfully" }}

返回值


4.11.6 获取图表信息

功能介绍

获取定制视图中增加的视图信息

URIURI格式



rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage?dyname={dyname}




dyname Y String 视图名称

请求

请求样例：GEThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage?dyname=%27111%27

响应

成功响应样例：{ "res_data": { "param_list": "[{'req_data': [{'KPIList': ['10000007_USN_USN_1000_15', '10000008_USN_USN_1000_15', '10000009_USN_USN_1000_15'], 'startTime': '', 'endTime': '', 'layout': '0', 'tbname': 'test', 'dyname': 'test', 'tbnameTarget': 'test', 'operationType': '0'}]}]" }}

返回值


4.11.7 新增图表

功能介绍

新增图表信息

URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage




KPIList Y Arrary KPI指标列表

startTime Y date 起始时间。取值为空时，使用系统参数的看板默认显示时间。




endTime Y date 结束时间。取值为空时，使用系统参数的看板默认显示时间。

layout Y String 图表布局

tbname Y String 图表名称


tbnameTarget Y String 当前视图名称

operationType Y String 操作类型

包含如下取值：

● 0：新增

● 1：修改

请求

请求样例：POST https://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage{ "req_data": [ { "KPIList": [ "10000013_USN_USN_1000_30", "10000014_USN_USN_1000_30", "10000015_USN_USN_1000_30" ], "startTime": "", "endTime": "", "layout": "0", "tbname": "zzz", "dyname": "test", "tbnameTarget": "zzz", "operationType": "0" } ]}

响应

成功响应样例："save success!"

返回值


4.11.8 修改图表

功能介绍

修改图表相关信息



URI

URI格式/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage




KPIList Y Arrary KPI指标列表

startTime Y date 起始时间。取值为空时，使用系统参数的看板默认显示时间。

endTime Y date 结束时间。取值为空时，使用系统参数的看板默认显示时间。

layout Y String 图表布局

tbname Y String 修改后的图表名称


tbnameTarget Y String 修改前的视图名称

operationType Y String 操作类型


● 0：新增

● 1：修改

请求

请求样例：POSThttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage{ "req_data": [ { "KPIList": [ "10000007_USN_USN_1000_15", "10000008_USN_USN_1000_15", "10000009_USN_USN_1000_15" ], "startTime": "", "endTime": "", "layout": "0", "tbname": "zzz", "tbnameTarget": "zzz", "dyname": "test", "dynameTarget": "test", "operationType": "1" } ]}



响应● 成功响应样例

"update success!"

返回值


4.11.9 删除图表

功能介绍

删除图表信息。





tbname Y String 图表名称


operationType Y String 操作类型。取值为“1”，含义为删除。

请求

请求样例：DELETEhttps://console.ulanqab.huawei.com/domainconsole/rest/telcloud.huawei.com/domainconsole/anomalydetection/v1/singlekpi/monitormanage{ "req_data": [ { "tbname": "111", "dyname": "111", "operationType": "1" } ]}

响应● 成功响应样例

"delete successfully!"

返回值




4.12 公共参数

4.12.1 通用请求返回值

通用请求，成功响应后的返回值，如表4-39所示。

表 4-39 返回值

返回值说明

200 OK 请求成功。

202 Accepted 接受请求。

通用请求，异常响应后的返回值，如表4-40所示。

表 4-40 返回值

返回值说明

400 Bad Request 请求错误。

401 Unauthorized 鉴权失败。

403 Forbidden 没有操作权限。

404 Not Found 找不到资源。

500 Internal Server Error 服务内部错误。

503 Service Unavailable 服务不可用。

4.12.2 错误码说明

错误码类型说明建议解决方法

23469334.40000.00001

业务相关错误 database inserttable failed

检查请求传递的参数是否符合要求

23469334.40000.00002

业务相关错误 query fromdatabase failed


23469334.40000.00003

业务相关错误 query data fromdatabase is empty


23469334.40000.00004

业务相关错误 database tablealready exist





23469334.40000.00005

业务相关错误 database deletetable failed


23469334.40000.00006

业务相关错误 database updatetable failed


23469334.40000.01001

业务相关错误 validate therequest paramsfailed

请重试或请联系华为工作人员

23469334.40000.01002

业务相关错误 regularizationpattern matchfailed


23469334.40000.01003

业务相关错误 parameter lengthvarify failed.


23469334.40000.01004

业务相关错误 requiredparameters isNone


23469334.40000.01005

业务相关错误 time format verifyfailed


23469334.40000.01006

业务相关错误 parameter typeverify failed


23469334.40000.01007

业务相关错误 parameter is outof range


23469334.40000.02001

业务相关错误 kpi_id alreadyexist


23469334.40000.02002

业务相关错误 please order morekpi index


23469334.40000.02003

业务相关错误 sampling_periodis not unique


23469334.40000.02004

业务相关错误 collect_timeintervalinconsistent


23469334.40000.02005

业务相关错误 observed_valuezero value ratioexceeds 30percent


23469334.40000.02006

业务相关错误 request method isnot supported


23469334.40000.02007

业务相关错误 start time shouldnot be later thanend time





23469334.40000.10001

业务相关错误 download fromobs failed


23469334.40000.10001

业务相关错误 file resolve failed 请重试或请联系华为工作人员

23469334.40000.02046

参数异常参数命名不符合要求规范


23469334.40000.02047

参数异常参数长度不符合要求规范


23469334.40000.02048

参数异常参数为空，不符合要求规范


23469334.40000.02049

参数异常参数时间格式不符合要求规范


23469334.40000.02050

参数异常参数类型不符合要求规范


23469334.40000.02051

参数异常参数不符合使用要求规范


23469334.40000.02052

参数异常参数为空，不符合要求规范


23469334.40000.02053

参数异常采样周期不一致检查请求传递的参数是否符合要求

23469334.40000.02054

参数异常 collect_time不一致


23469334.40000.02055

参数异常 observed_value 为0的比例大于30%




4.13 修订记录


2020-03-30 修改“异常结果”节点如下内容：

● 新增异常结果删除

● 修改批量导出异常信息

修改“可视化看板”节点如下内容：

● 查询KPI检测相关数据

● 查询KPI ID● 新增图表

● 修改图表

修改“检测参数配置”节点如下内容：

● 查询系统参数

● 修改系统参数

2019-12-30 删除“KPI属性配置->新增KPI属性配置”内容

修改“数据配置”章节如下内容：

● 导入数据

● 下载导入摸板

新增“错误码说明”章节。

2019-10-30 第一次正式发布。



5 常见问题

5.1 KPI 异常检测的业务场景有哪些？异常检测（Anomaly Detection）特指在运维领域中，对KPI指标的时序数据进行异常检测，如：CPU使用率、电话接通率等。目的是通过时序数据中的状态变化，实现KPI异常的检测。

5.2 KPI 异常检测是否可以解决所有异常场景？异常包括如下两个层次：

● 数据异常：单纯从数学层面进行分析，判断样本值相对整体的离群程度是否很大。例如，平时CPU使用率为1%，突然升至10%，从数学层面分析，属于异常。

● 业务异常：数据异常和业务异常不完全一样，上述案例是10%的CPU使用率在数学层面异常，但在业务层面，10%的CPU使用率并没有问题，因此需要引入相关的业务经验加以判断。

目前时序KPI异常检测服务已支持数据异常检测和用户自定义业务规则，用于提高业务异常识别的准确率。

5.3 KPI 数据分类一般有哪些？KPI曲线目前分为两大类：周期性趋势和非周期性趋势。针对不同的趋势变化类型需要分别进行建模。

5.4 修订记录


2020-03-30 本次版本无变更。

2019-04-30 第一次正式发布。

NAIEKPI 异常检测模型服务 5 常见问题


6 产品术语

AAPI

全称Application Programming Interface。应用软件编程接口，即一些预先定义的函数，目的是提供应用程序，使得开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码或理解内部工作机制的细节。

KKPI

全称：Key Performance Indicator。关键性能指数，代表某对象某一时刻的性能值。KPI也可能由多级KPI汇聚而来。

NAIEKPI 异常检测模型服务 6 产品术语


KPI 异常检测模型服务 - HUAWEI CLOUD · 2020. 7. 12. · kpi数量的计算方法为：kpi数量 = 单节点kpi数量 * 节点数量。 计费公式为：单位价格 * kpi步长数量

Documents

KPI 异常检测模型服务 - HUAWEI CLOUD · 2020. 7. 12. · kpi数量的计算方法为：kpi数量 = 单节点kpi数量 * 节点数量。计费公式为：单位价格 * kpi步长数量