附录C：API 接口规范

统计计算接口

创建统计

描述

格式

示例

{
    "action": "create_statistics_task",
    "key": "v1",
    "func": "count",
    "name": "123",
    "filter": "sff",
    "result": {
        "precision": 4
    },
    "schedule": {
        "spec": "0 */1 * * * *"
    },
    "object_list": ["OBJ1243475500002","OBJ1243475500001"]
}

返回

• uid：uid唯一标识一个统计项目
• var_name:var_name 唯一表示一个统计项目的结果

{
    "resp": "create_statistics_task",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "STATISTICS1395846800005"
    }
}

计算命题

描述

格式

示例

{
    "action": "create_calculate_task",
    "expr":"STATISTICS1391005100002",
    "trigger":["STATISTICS1391005100002"],
    "result":{
        "precision":3
    }
}

返回

• uid：uid唯一标识一个统计项目
• var_name:var_name 唯一表示一个统计项目的结果

{
    "resp": "create_calculate_task",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "CALCULATE1302391300002"
    }
}

启动统计

描述

格式

示例

{
    "action": "start_statistics_task",
    "uid":"STATISTICS1395587100001"
}

返回

{
    "resp": "start_statistics_task",
    "code": 200,
    "msg": "成功",
    "result": {
        "next": "2021-03-30 09:59:54"
    }
}

启动计算

描述

格式

示例

{
    "action": "start_calculate_task",
    "uid":"CALCULATE1302391300002"
}

返回

{
    "resp": "start_calculate_task",
    "code": 200,
    "msg": "成功"
}

停止统计

描述

格式

示例

{
    "action": "stop_statistics_task",
    "uid":"STATISTICS1341891700001"
}

返回

{
    "resp": "stop_statistics_task",
    "code": 200,
    "msg": "成功"
}

停止计算

描述

格式

示例

{
    "action": "stop_calculate_task",
    "uid":"CALCULATE1381575800012"
}

返回

{
    "resp": "stop_calculate_task",
    "code": 200,
    "msg": "成功"
}

取消统计

描述

格式

示例

{
    "action": "cancel_statistics_task",
    "uid":"STATISTICS1391005100002"
}

返回

{
    "resp": "cancel_statistics_task",
    "code": 200,
    "msg": "成功"
}

取消计算

描述

格式

示例

{
    "action": "cancel_calculate_task",
    "uid":"CALCULATE1302904900002"
}

返回

{
    "resp": "cancel_calculate_task",
    "code": 200,
    "msg": "成功"
}

获取统计项目列表

描述

格式

示例

{
    "action":"get_statistics_task_list"
}

返回

{
    "resp": "get_statistics_task_list",
    "code": 200,
    "msg": "成功",
    "result": [
        "STATISTICS1305433500001"
    ]
}

获取计算项目列表

描述

格式

示例

{
    "action":"get_calculate_task_list"
}

返回

{
    "resp": "get_calculate_task_list",
    "code": 200,
    "msg": "成功",
    "result": [
        "CALCULATE1305256100003",
        "CALCULATE1305483400004",
        "CALCULATE1305595400005",
        "CALCULATE1305665000006"
    ]
}

获取统计最新结果值(内存值)

描述

格式

示例

{
    "action": "get_statistics_value",
    "uid":"STATISTICS1354093700001",
    "object_id":"OBJ1354093712581"
}

返回

{
    "resp": "get_statistics_value",
    "code": 200,
    "msg": "成功",
    "result": {
        "time_pair": {
            "start": "2021-03-30 14:12:22.001010625",
            "end": "2021-03-30 14:12:23.000961867"
        },
        "data": 538
    }
}

获取计算最新结果值(内存值)（暂不提供）

获取统计备份数据

描述

格式

示例

{
    "action": "get_backup_task_record",
    "uid":"STATISTICS1584816000007",
    "object_id":"OBJ1570163200002"
}

返回

{
    "resp": "get_newest_statistics_value",
    "code": 200,
    "msg": "成功",
    "result": {
      "key": "W_Consumption_Hour_HHADZB_31",
      "last_time": "2022-10-28T14:52:08.703062905+08:00",
      "start_time": "2022-10-28T14:30:00+08:00",
      "end_time": "2022-10-28T15:00:00+08:00",
      "result": "{\"Heap\":[{\"data\":850922.4,\"time\":\"2022-10-28T14:50:08.708654679+08:00\",\"last_time\":\"2022-10-28T14:49:08.714062279+08:00\",\"start_time\":\"2022-10-28T14:30:00+08:00\",\"end_time\":\"2022-10-28T15:00:00+08:00\"},{\"data\":850922.4,\"time\":\"2022-10-28T14:51:08.725343092+08:00\",\"last_time\":\"2022-10-28T14:50:08.708654679+08:00\",\"start_time\":\"2022-10-28T14:30:00+08:00\",\"end_time\":\"2022-10-28T15:00:00+08:00\"},{\"data\":850924.8,\"time\":\"2022-10-28T14:52:08.703062905+08:00\",\"last_time\":\"2022-10-28T14:51:08.725343092+08:00\",\"start_time\":\"2022-10-28T14:30:00+08:00\",\"end_time\":\"2022-10-28T15:00:00+08:00\"}],\"Extra\":[{\"data\":850920,\"time\":\"2022-10-28T14:45:08.714220319+08:00\",\"last_time\":\"2022-10-28T14:44:08.717916403+08:00\",\"start_time\":\"2022-10-28T14:30:00+08:00\",\"end_time\":\"2022-10-28T15:00:00+08:00\"},{\"data\":850920,\"time\":\"2022-10-28T14:46:08.728271089+08:00\",\"last_time\":\"2022-10-28T14:45:08.714220319+08:00\",\"start_time\":\"2022-10-28T14:30:00+08:00\",\"end_time\":\"2022-10-28T15:00:00+08:00\"},{\"data\":850920,\"time\":\"2022-10-28T14:47:08.712719138+08:00\",\"last_time\":\"2022-10-28T14:46:08.728271089+08:00\",\"start_time\":\"2022-10-28T14:30:00+08:00\",\"end_time\":\"2022-10-28T15:00:00+08:00\"},{\"data\":850920,\"time\":\"2022-10-28T14:48:08.708412118+08:00\",\"last_time\":\"2022-10-28T14:47:08.712719138+08:00\",\"start_time\":\"2022-10-28T14:30:00+08:00\",\"end_time\":\"2022-10-28T15:00:00+08:00\"},{\"data\":850922.4,\"time\":\"2022-10-28T14:49:08.714062279+08:00\",\"last_time\":\"2022-10-28T14:48:08.708412118+08:00\",\"start_time\":\"2022-10-28T14:30:00+08:00\",\"end_time\":\"2022-10-28T15:00:00+08:00\"}],\"Data\":14.400000000023283}"
    }
}

刷新统计实时数据到磁盘

{
    "action": "refresh_task_record"
}

获取统计状态

当前状态只有 start，stop两种值

描述

格式

示例

{
    "action": "get_statistics_stat",
    "uid":"STATISTICS1354093700001"
}

返回

{
    "resp": "get_statistics_stat",
    "code": 200,
    "msg": "成功",
    "result": "start"
}

获取计算状态

描述

格式

示例

{
    "action": "get_calculate_stat",
    "uid":"CALCULATE1341392400154"
}

返回

{
    "resp": "get_calculate_stat",
    "code": 200,
    "msg": "成功",
    "result": "stop"
}

统计追加对象（新增）

示例

{
    "action": "statistics_append_object",
    "uid":"STATISTICS2921773713567",
    "object_list": ["OBJ001","OBJ002"]
}

统计删除对象（新增）

示例

{
    "action": "statistics_delete_object",
    "uid":"STATISTICS2921773713567",
    "object_id": "OBJ001"
}

启动统计子任务（新增）

示例

{
    "action": "start_statistics_object_task",
    "uid":"STATISTICS2921773713567",
    "object_id": "OBJ001"
}

停止统计子任务（新增）

示例

{
    "action": "stop_statistics_object_task",
    "uid":"STATISTICS2921773713567",
    "object_id": "OBJ001"
}

统计子任务列表（新增）

示例

{
    "action": "get_statistics_object_task_list",
    "uid":"STATISTICS2921773713567"
}

返回

{
  "resp": "get_statistics_object_task_list",
  "actionid": "",
  "code": 200,
  "msg": "成功",
  "result": [
    {
      "id": 0,
      "statistics_uid": "STATISTICS2921773713567",
      "object_id": "A211003_04",
      "is_active": 1
    }
  ]
}

获取统计脚本详情

描述

格式

示例

{
    "action": "get_statistics_task_detail",
    "uid":"STATISTICS1303162000001"
}

返回

{
    "resp": "get_statistics_task_detail",
    "code": 200,
    "msg": "成功",
    "result": {
        "func": "accumulate",
        "key": "v1",
        "object_list": ["OBJ1343477200007"],
        "result": {
            "precision": 4,
            "var_name":"f"
        },
        "schedule": {
            "spec": "0/10 * * * * *"
        }
    }
}

获取计算脚本详情

描述

格式

示例

{
    "action": "get_calculate_task_detail",
    "uid":"CALCULATE1344002700003"
}

返回

{
    "resp": "get_calculate_task_detail",
    "code": 200,
    "msg": "成功",
    "result": {
        "expr": "STATISTICS1301522700002",
        "result": {
            "precision": 3,
            "var_name":"Y1"
        },
        "trigger": [
            "STATISTICS1301522700002"
        ]
    }
}

创建过滤模型

描述

格式

示例

{
    "action": "create_filter_model",
    "first_min":4,
    "first_max":3,
    "sigma":2,
    "mean_factor":1
}

返回

{
    "resp": "create_filter_model",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "FILTER1412781700013"
    }
}

创建条件模型

描述

格式

示例

{
    "action":"create_condition_model",
    "logic_expr":"v1 + 5 > 0",
    "obj_var_list":["v1"],
    "default":false
}

返回

{
    "resp": "create_condition_model",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "CONDITION1414618400001"
    }
}

更新过滤模型

描述

格式

示例

{
    "action":"update_filter_model",
    "uid":"FILTER1412781700013",
    "first_min":4,
    "first_max":3,
    "sigma":2,
    "mean_factor":1
}

返回

{
    "resp": "update_filter_model",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "FILTER1412781700013"
    }
}

更新条件模型

描述

格式

示例

{
    "action":"update_condition_model",
    "uid":"CONDITION1414618400001",
    "logic_expr":"v1 + 5 > 4200",
    "obj_var_list":["v1"],
    "default":true
}

返回

{
    "resp": "update_condition_model",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "CONDITION1414618400001"
    }
}

获取过滤模型详情

描述

格式

示例

{
    "action":"get_filter_detail",
    "uid":"FILTER1410561000074"
}

返回

{
    "resp": "get_filter_detail",
    "code": 200,
    "msg": "成功",
    "result": {
        "first_min": 4,
        "first_max": 3,
        "sigma": 2,
        "mean_factor": 1
    }
}

获取条件模型详情

描述

格式

示例

{
    "action":"get_condition_detail",
    "uid":"CONDITION1414932900005"
}

返回

{
    "resp": "get_condition_detail",
    "code": 200,
    "msg": "成功",
    "result": {
        "logic_expr": "v1 + 5 > 4200",
        "obj_var_list": [
            "v1"
        ],
        "default": false
    }
}

获取过滤模型列表

描述

格式

示例

{
    "action":"get_filter_list"
}

返回

{
    "resp": "get_filter_list",
    "code": 200,
    "msg": "成功",
    "result": [
        "FILTER1414932900005",
        "FILTER1410561000074"
    ]
}

获取条件模型列表

描述

格式

示例

{
    "action":"get_condition_list"
}

返回

{
    "resp": "get_condition_list",
    "code": 200,
    "msg": "成功",
    "result": [
        "CONDITION1410556800016",
        "CONDITION1413955100001"
    ]
}

删除过滤模型

描述

格式

示例

{
    "action":"delete_filter_model",
    "uid":"FILTER1412818200003"
}

返回

{
    "resp": "delete_filter_model",
    "code": 200,
    "msg": "成功"
}

删除条件模型

描述

格式

示例

{
    "action":"delete_condition_model",
    "uid":"CONDITION1410556800016"
}

返回

{
    "resp": "delete_condition_model",
    "code": 200,
    "msg": "成功"
}

描述

格式

示例

{
    "action": "create_manual_task",
    "uid":"STATISTICS1662145300004",
    "object_id":"OBJ1243475500002",
    "duration":{
        "start":"2021-06-24 10:00:00",
        "end":"2021-06-24 14:00:00"
    }
}

返回

{
    "resp": "create_manual_task",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "MANUAL1662524900003"
    }
}

获取重算任务详情（移除）

描述

每个重算任务(叫做job)，会根据统计spec细分为N个重算周期，也就是N个task,每个task有三种状态:

1. task created(task创建):job created(job创建) -> job prepared(job就绪) 这两种状态变迁的过程中，会创建task,并且设置为task created(task创建)
2. task error(task错误):当job进入job running(job 运行)状态时,会执行task,每个task执行过程中,如果错误,会被设置为这个task error(task错误)状态
3. task finished(task完成):当成功完成一个task的时候,会设置为task finished(task完成)状态,当归属于job的所有task都完成的时候,会设置job finished(job完成)状态

格式

示例

{
    "action":"get_manual_task_detail",
    "uid":"MANUAL1662524900003"
}

返回

{
    "resp": "get_manual_task_detail",
    "code": 200,
    "msg": "成功",
    "result": {
        "job": {
            "err": "<nil>",
            "tasks": [
                {
                    "err": "",
                    "stat": "task finished",
                    "time_pair": {
                        "end": "2021-06-24 10:01:00",
                        "start": "2021-06-24 10:00:00"
                    }
                },
                {
                    "err": "",
                    "stat": "task finished",
                    "time_pair": {
                        "end": "2021-06-24 10:02:00",
                        "start": "2021-06-24 10:01:00"
                    }
                },
                {
                    "err": "",
                    "stat": "task finished",
                    "time_pair": {
                        "end": "2021-06-24 10:03:00",
                        "start": "2021-06-24 10:02:00"
                    }
                }
                ....
            ]
        },
        "stat": "job running"
    }
}

获取重算脚本详情（移除）

描述

格式

示例

{
    "action":"get_manual_script_detail",
    "uid":"MANUAL1662524900003"
}

返回

{
    "resp": "get_manual_script_detail",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "STATISTICS1653434700002",
        "object_id": "OBJ1243475500002",
        "duration": {
            "start": "2021-06-24 06:00:00",
            "end": "2021-06-24 08:00:00"
        }
    }
}

获取重算任务列表（移除）

描述

默认获取的任务列表是不包含被删除的任务

格式

示例

{
    "action": "get_manual_list",
    "all":true
}

返回

{
    "resp": "get_manual_list",
    "code": 200,
    "msg": "成功",
    "result": [
        "MANUAL1663534700002"
    ]
}

删除重算任务（移除）

描述

将重算任务设置为job deleted(被删除状态)

格式

示例

{
    "action": "delete_manual_task",
    "uid":"MANUAL1650583600002"
}

返回

{
    "resp": "delete_manual_task",
    "code": 200,
    "msg": "成功"
}

启动重算任务（移除）

描述

最多可以允许10个重算任务同时运行

格式

示例

{
    "action": "start_manual_task",
    "uid":"MANUAL1662524900003"
}

返回

{
    "resp": "start_manual_task",
    "code": 200,
    "msg": "成功"
}

停止重算任务（移除）

描述

格式

示例

{
    "action": "stop_manual_task",
    "uid":"MANUAL1662524900003"
}

返回

{
    "resp": "stop_manual_task",
    "code": 200,
    "msg": "成功"
}

获取重算任务状态（移除）

描述

重算任务的状态有：

1. job created(创建):创建重算任务之后进入这个状态,完成重算周期拆分之后进入job prepared(就绪状态)
2. job prepared(就绪状态):当调用start之后，进入job running(运行状态)
3. job running(运行状态):获取原始数据进行统计,完成之后写入数据库表,完成所有的拆分周期重算之后,进入job finished(完成状态)
4. job stopped(被停止状态):只有处于job running(运行状态)的任务才可以被停止
5. job finished(完成状态):完成所有的拆分周期重算之后,进入job finished(完成状态)
6. job deleted(被删除状态):调用delete之后进入这个状态,处于这个状态的任务并没有真正被删除

格式

示例

{
    "action": "get_manual_stat",
    "uid":"MANUAL1662524900003"
}

返回

{
    "resp": "get_manual_stat",
    "code": 200,
    "msg": "成功",
    "result": "job running"
}

重算统计（新增）

示例

{
    "action": "recalculate_statistics",
    "task_uid":"MANUAL1662524900003",
    "object_list": ["OBJ001","OBJ002"],
    "start_time": "2022-10-28 01:00:00",
    "end_time": "2022-10-28 02:00:00"
}

设置统计重算参数（新增）

示例

{
    "action": "recalculate_statistics",
    "max_bucket_size": 1000,
    "max_running_bucket_size": 10,
    "max_period": 4 * 60 * 60* 1000 * 1000 * 1000 ,
}

重算计算（新增）

示例

{
    "action": "recalculate_calculate",
    "uid":"MANUAL1662524900003",
    "start_time": "2022-10-28 01:00:00",
    "end_time": "2022-10-28 02:00:00"
}

获取计算任务当前状态（新增）

{
    "action": "get_calculate_stat",
    "uid":"Calc_Put_HJ_Day",
    "object_id": "FK_270"
}

返回

{
  "resp": "get_calculate_stat",
  "actionid": "",
  "code": 200,
  "msg": "成功",
  "result": [
    {
      "Mu": {},
      "Uid": "HJ_WorkTime_Day",
      "ObjectId": "FK_270",
      "StartTime": "2022-10-28T00:00:00+08:00",
      "EndTime": "2022-10-28T00:00:00+08:00",
      "Data": 1.8312498685155605,
      "HasCalculate": true,
      "Time": "2022-10-28T15:07:32.324271711+08:00",
      "RealTimeData": 0.06032427584000004,
      "RealTimeCalculate": true
    }
  ]
}