自定义故障实体接口

接口原型

ascend-fd entity 子命令

功能说明

提供自定义故障实体的相关功能,包括新增或修改、查询或删除自定义故障实体,同时支持校验自定义故障实体custom-ascend-kg-config.json文件。

参数说明

表1 子命令参数说明

参数

缩写

是否必选

值类型

说明

--update

-u

必选,且参数间互斥,即只能指定一个且必须指定一个参数。

String

以json文件格式新增或修改自定义故障实体信息。

说明:

json文件的相关参数说明请参见表1

--delete

-d

String

删除指定对应故障码的自定义故障实体信息,多个故障码间使用空格分隔。

--show

-s

Int

查看用户自定义的故障实体信息。支持通过故障码查看故障信息,多个故障码间使用空格分隔;不指定故障码时将查询所有自定义故障实体信息。

--check

-c

String

校验custom-ascend-kg-config.json文件的合法性,主要校验每个自定义故障实体的字段属性的有效性。

--item

可选

String

查看自定义故障实体的部分信息。取值如下,多个取值间使用空格分隔,不指定取值时将展示以下3个取值的信息。

  • attribute:属性信息
  • rule:故障链
  • regex:故障关键字
说明:

必须与--show(或-s)字段一起使用。

--force

-f

可选

Bool

指定该参数删除自定义故障实体时,界面将不会出现确认提示信息。

说明:

必须与--delete(或-d)字段一起使用。

--help

-h

可选

-

查询使用说明。

返回说明

例如通过json文件,新增自定义故障实体。

ascend-fd entity -u test_base.json
Updated entity successfully.