新建单个定时报告¶

POST /api/v1/crontab_report/add

概述¶

Body 请求参数¶

参数名	类型	必选	说明
title	string	Y	定时报告名称允许为空: True 最大长度: 200
content	string		定时报告内容允许为空: True 最大长度: 1000 允许空字符串: True
dashboardUUID	string	Y	仪表板uuid 允许为空: False
recipient	array	Y	收件人信息例子: [acnt_xxxx, 22@qq.com, acnt_yyy] 允许为空: False
variables	json		视图变量信息允许为空: True
timeRange	string	Y	查询时间范围例子: 1d 允许为空: True
crontab	string		定时任务的crontab 例子: 1 2 * * * 允许为空: True 允许空字符串: True
singleExecuteTime	int		单次执行的时间戳允许为空: True
extend	json		额外信息允许为空: True
timezone	string	Y	定时报告时区例子: Asia/Shanghai 允许为空: True
notifyType	string	Y	定时报告通知类型例子: email 允许为空: True 可选值: ['email', 'dingTalkRobot', 'wechatRobot', 'feishuRobot']

参数补充说明¶

数据说明.*

请求参数说明

参数名	type	说明
title	string	定时报告名称
content	string	定时报告内容
dashboardUUID	string	定时报告的仪表板UUID
recipient	list	定时报告的接收人信息列表,用户账号acnt_/邮箱/通知对象uuid
variables	json	视图变量信息
timeRange	string	查询时间范围,整数加d/h/m格式, 列如: 3d, 15m, 2h
crontab	string	重复执行的定时任务的crontab
singleExecuteTime	int	单次执行的时间戳
extend	json	扩展信息,用于前端界面展示信息显示
timezone	string	时区
notifyType	string	通知类型,枚举值(email,dingTalkRobot,wecharRobot, feishuRobot)

extend扩展字段说明

参数名	type	说明
shareConfig	json	定时报告分享配置
shareConfig.shareMethod	string	定时报告分享配置 public or encipher 公开和加密默认公开
shareConfig.password	string	定时报告分享密码加密分享密码

请求例子¶

curl 'https://openapi.guance.com/api/v1/crontab_report/add' \
-H 'Accept-Language: zh' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Accept: application/json, text/plain, */*' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"title":"ceshi2","content":"","dashboardUUID":"dsbd_28a1718f1b5547a58a40f2167948bdc6","recipient":["acnt_e85847e7fe894ea9938dd29c22bc1f9b"],"timeRange":"1d","singleExecuteTime":1698718800,"crontab":"","extend":{"cycleTimeType":"once","hour":"10","minutes":"20","dashboardInfo":{"value":"dsbd_28a1718f1b5547a58a40f2167948bdc6","label":"whytest"}},"timezone":"Asia/Shanghai","notifyType":"email"}' \
--compressed

响应¶

{
    "code": 200,
    "content": {
        "content": "",
        "createAt": 1698665760,
        "creator": "wsak_xxxxx",
        "crontab": "",
        "dashboardUUID": "dsbd_28a1718f1b5547a58a40f2167948bdc6",
        "deleteAt": -1,
        "executed": 0,
        "extend": {
            "cycleTimeType": "once",
            "dashboardInfo": {
                "label": "whytest",
                "value": "dsbd_28a1718f1b5547a58a40f2167948bdc6"
            },
            "hour": "10",
            "minutes": "20"
        },
        "id": 205,
        "isLocked": 0,
        "notifyType": "email",
        "recipient": [
            "acnt_e85847e7fe894ea9938dd29c22bc1f9b"
        ],
        "singleExecuteTime": 1698718800,
        "status": 0,
        "timeRange": "1d",
        "timezone": "Asia/Shanghai",
        "title": "ceshi2",
        "updateAt": 1698665760,
        "updator": "wsak_xxxxx",
        "uuid": "cron_3a819c6c1d4e4fcea690b18e678b174f",
        "variables": {},
        "workspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-F4667E68-FB26-4987-891B-F00909A2948D"
}