新增异常/巡检告警定义

开发中

POST

/def/add

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

user_id

string

已废弃

默认值:

username

string

已废弃

默认值:

user_key

string

已废弃

默认值:

Body 参数application/json

taskName

string

任务名称

可选

<= 100 字符

默认值:

null

systemCode

string

系统编码

必需

<= 100 字符

systemName

string

系统名称

必需

defType

integer

可选

定义类型 1-异常数据巡检任务、2-异常报警消息模板

>= 0<= 4294967296

默认值:

cronExpr

string

可选

任务执行cron表达式 def_type=1时有效

<= 100 字符

默认值:

null

alarmContent

string

报警内容

必需

<= 255 字符

larkChatId

string

推送飞书群ID

必需

<= 100 字符

triggerExpr

string

触发表达式

可选

<= 100 字符

默认值:

null

atScope

integer

可选

@人范围 1-@全部 2-@指定人

>= 0<= 4294967296

默认值:

powerJobId

integer

可选

powerJobID，操作job的唯一标识

>= 0<= 1.461501637330903e+48

默认值:

null

remark

string

备注

可选

<= 255 字符

默认值:

null

busiExceptionDefMetrics

array [object {6}]

指标

必需

datasourceId

integer

数据源ID

必需

>= 0<= 1.461501637330903e+48

execSql

string

SQL语句

必需

<= 2000 字符

sqlDesc

string

SQL语句描述

可选

<= 100 字符

默认值:

null

defExprVariable

string

必需

触发表达式中的变量标识

<= 100 字符

remark

string

备注

可选

<= 255 字符

默认值:

null

updateBy

string

更新人

可选

<= 64 字符

默认值:

null

busiExceptionDefAtEmploys

array[object (busi_exception_def_at_employ) {9}]

告警人员

可选

integer

可选

>= 1<= 1.461501637330903e+48

defId

integer

异常监控定义ID

必需

>= 0<= 1.461501637330903e+48

employId

string

ps人员编码

必需

<= 100 字符

remark

string

备注

可选

<= 255 字符

默认值:

null

delFlag

integer

可选

是否删除 0-否、1-是

>= 0<= 256

默认值:

createBy

string

创建人

可选

<= 64 字符

默认值:

null

createTime

string <date-time>

创建时间

可选

默认值:

null

updateBy

string

更新人

可选

<= 64 字符

默认值:

null

updateTime

string <date-time>

更新时间

可选

默认值:

null

示例

{
    "taskName": null,
    "systemCode": "string",
    "systemName": "string",
    "defType": "1",
    "cronExpr": null,
    "alarmContent": "string",
    "larkChatId": "string",
    "triggerExpr": null,
    "atScope": "1",
    "powerJobId": null,
    "remark": null,
    "busiExceptionDefMetrics": [
        {
            "datasourceId": 0,
            "execSql": "string",
            "sqlDesc": null,
            "defExprVariable": "string",
            "remark": null,
            "updateBy": null
        }
    ],
    "busiExceptionDefAtEmploys": [
        {
            "id": 1,
            "defId": 0,
            "employId": "string",
            "remark": null,
            "delFlag": "0",
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'finance-gateway.hdltest.com/acct-payable/def/add' \
--header 'user_id: {{user_id}}' \
--header 'username: {{username}}' \
--header 'user_key: {{user_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "taskName": null,
    "systemCode": "string",
    "systemName": "string",
    "defType": "1",
    "cronExpr": null,
    "alarmContent": "string",
    "larkChatId": "string",
    "triggerExpr": null,
    "atScope": "1",
    "powerJobId": null,
    "remark": null,
    "busiExceptionDefMetrics": [
        {
            "datasourceId": 0,
            "execSql": "string",
            "sqlDesc": null,
            "defExprVariable": "string",
            "remark": null,
            "updateBy": null
        }
    ],
    "busiExceptionDefAtEmploys": [
        {
            "id": 1,
            "defId": 0,
            "employId": "string",
            "remark": null,
            "delFlag": "0",
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

key

object

可选

示例

{
    "key": {}
}

修改于 2023-03-28 08:26:39

异常告警列表导出

修改异常/巡检告警定义