1. 特征检测、特征统计接口文档

1.1. 特征检测接口

1.1.1. 实时检测

1.1.1.1. 创建实时检测项目 create_adaps_project

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令：create_adaps_project
actionid 否 string 指令编号
organization_id 否 string 组织ID
name 是 string 项目名称
alias 是 string 项目别名
description 否 string 项目描述信息
object_id 是 string 对象编号
duration 是 int 检测周期
script 是 object 脚本

响应参数：

{
    "resp": "create_adaps_project",
    "code": 200,
    "msg": "成功",
    "result": {
        "id": 6,
        "organization_id": "",
        "uid": "ADP3773011700053",
        "name": "ddf",
        "alias": "ddf",
        "object_id": "yjj",
        "duration": 6,
        "description": "",
        "is_available": 0,
        "script": {
            "Main": [
                [
                    "ddf",
                    "DDF",
                    "S01",
                    [
                        10,
                        5,
                        10,
                        45
                    ]
                ]
            ],
            "Relate": null,
            "ExtraKey": null
        },
        "created": "",
        "last_modified": ""
    }
}

1.1.1.2. 编辑实时检测项目 update_adaps_project

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令：update_adaps_project
actionid 否 string 指令编号
uid 是 string uid
organization_id 否 string 组织ID
name 是 string 项目名称
alias 是 string 项目别名
description 否 string 项目描述信息
object_id 是 string 对象编号
duration 是 int 检测周期
script 是 object 脚本

响应参数：

{
    "resp": "update_adaps_project",
    "code": 200,
    "msg": "成功",
    "result": {
        "id": 6,
        "organization_id": "",
        "uid": "ADP3773011700053",
        "name": "ddf",
        "alias": "ddf",
        "object_id": "yjj",
        "duration": 6,
        "description": "",
        "is_available": 0,
        "script": {
            "Main": [
                [
                    "ddf",
                    "DDF",
                    "S01",
                    [
                        10,
                        5,
                        10,
                        45
                    ]
                ]
            ],
            "Relate": null,
            "ExtraKey": null
        },
        "created": "",
        "last_modified": ""
    }
}

1.1.1.3. 删除实时检测项目 delete_adaps_project

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令：delete_adaps_project
actionid 否 string 指令编号
uid 是 string uid

响应参数：

{
    "resp": "delete_adaps_project",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "ADP3773011700053",
        "name": "ddf"
    }
}

1.1.1.4. 开启实时检测项目 start_adaps_project

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令：start_adaps_project
actionid 否 string 指令编号
uid 是 string uid

响应参数：

{
    "resp": "start_adaps_project",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "ADP3773011700053",
        "name": "ddf"
    }
}

1.1.1.5. 停止实时检测项目 stop_adaps_project

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令：stop_adaps_project
actionid 否 string 指令编号
uid 是 string uid

响应参数：

{
    "resp": "stop_adaps_project",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "ADP3773011700053",
        "name": "ddf"
    }
}

1.1.1.6. 获取实时检测项目详情 get_adaps_project_item

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令：get_adaps_project_item
actionid 否 string 指令编号
uid 是 string uid

响应参数：

{
    "resp": "get_adaps_project_item",
    "code": 200,
    "msg": "成功",
    "result": {
        "id": 6,
        "organization_id": "",
        "uid": "ADP3773011700053",
        "name": "ddf",
        "alias": "ddf",
        "object_id": "yjj",
        "duration": 6,
        "description": "",
        "is_available": 0,
        "script": {
            "Main": [
                [
                    "ddf",
                    "DDF",
                    "S01",
                    [
                        10,
                        5,
                        10,
                        45
                    ]
                ]
            ],
            "Relate": null,
            "ExtraKey": null
        },
        "created": "",
        "last_modified": ""
    }
}

1.1.1.7. 获取实时检测项目列表 get_adaps_project_list

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令：get_adaps_project_list
actionid 否 string 指令编号
page_index 否 int 当前页
page_size 否 int 每页数
where_and 否 string and 条件
where_in 否 string in 条件
where_or 否 string or 条件

响应参数：

{
    "resp": "get_adaps_project_list",
    "code": 200,
    "msg": "成功",
    "result": {
        "page_index": 1,
        "page_size": 10,
        "total_pages": 1,
        "total_records": 4,
        "data": [
            {
                "id": 6,
                "organization_id": "",
                "uid": "ADP3773011700053",
                "name": "ddf",
                "alias": "ddf",
                "object_id": "yjj",
                "duration": 6,
                "description": "",
                "is_available": 0,
                "script": {
                    "Main": null,
                    "Relate": null,
                    "ExtraKey": null
                },
                "created": "",
                "last_modified": ""
            }
        ]
    }
}

1.1.1.8. 获取实时检测结果报告

1.1.2. 特征检测事件Event

1.1.2.1. 出现特征事件

{
  "event":"appear_adaps",
  "block":"adaps",
  "uniqueid":"ADP3770652600005",
  "datetime":"2023-07-27 16:51:06",
  "code": "ADC3470652601206",
  "organization_id":"",
  "project_uid":"adap1",
  "object_id":"yjj",
  "Start":"2023-07-27T16:50:56.532396+08:00",
  "End":"2023-07-27T16:51:06.532396+08:00",
  "Detail":{
    "Main":[
      {
        "key":"jpm",
        "key_type":"JMP",
        "fv":"S01",
        "interval":10,
        "params":[10,5,5,"p"],
        "report":[
          {
            "start":{"datetime":"2023-07-27T16:50:56.610857091+08:00","data":{"S01":48.72,"S02":58.42,"S03":50.42}},
            "vertex":{"datetime":"2023-07-27T16:51:00.621791876+08:00","data":{"S01":53.88,"S02":52.14,"S03":49.54}},
            "end":{"datetime":"2023-07-27T16:51:01.622750774+08:00","data":{"S01":40.75,"S02":47.12,"S03":40.81}},
            "increase":5.160000000000004,
            "decrease":13.130000000000003
          },
          {
            "start":{"datetime":"2023-07-27T16:51:01.622750774+08:00","data":{"S01":40.75,"S02":47.12,"S03":40.81}},
            "vertex":{"datetime":"2023-07-27T16:51:03.631257439+08:00","data":{"S01":58.54,"S02":55.33,"S03":47.04}},
            "end":{"datetime":"2023-07-27T16:51:04.633739819+08:00","data":{"S01":44.91,"S02":47.52,"S03":60.89}},
            "increase":17.79,"decrease":13.630000000000003
          }
        ]
      }
    ]
  }
}

1.1.2.2. 特征持续事件

{
  "event":"continue_adaps",
  "block":"adaps",
  "uniqueid":"ADP3770652600005",
  "datetime":"2023-07-27 16:51:06",
  "code": "ADC3470652601206",
  "organization_id":"",
  "project_uid":"adap1",
  "object_id":"yjj",
  "Start":"2023-07-27T16:50:56.532396+08:00",
  "End":"2023-07-27T16:51:06.532396+08:00",
  "Detail":{
    "Main":[
      {
        "key":"jpm",
        "key_type":"JMP",
        "fv":"S01",
        "interval":10,
        "params":[10,5,5,"p"],
        "report":[
          {
            "start":{"datetime":"2023-07-27T16:50:56.610857091+08:00","data":{"S01":48.72,"S02":58.42,"S03":50.42}},
            "vertex":{"datetime":"2023-07-27T16:51:00.621791876+08:00","data":{"S01":53.88,"S02":52.14,"S03":49.54}},
            "end":{"datetime":"2023-07-27T16:51:01.622750774+08:00","data":{"S01":40.75,"S02":47.12,"S03":40.81}},
            "increase":5.160000000000004,
            "decrease":13.130000000000003
          },
          {
            "start":{"datetime":"2023-07-27T16:51:01.622750774+08:00","data":{"S01":40.75,"S02":47.12,"S03":40.81}},
            "vertex":{"datetime":"2023-07-27T16:51:03.631257439+08:00","data":{"S01":58.54,"S02":55.33,"S03":47.04}},
            "end":{"datetime":"2023-07-27T16:51:04.633739819+08:00","data":{"S01":44.91,"S02":47.52,"S03":60.89}},
            "increase":17.79,"decrease":13.630000000000003
          }
        ]
      }
    ]
  }
}

1.1.2.3. 特征事件消失事件

{
    "event": "disappear_adaps",
    "block": "adaps",
    "uniqueid": "ADP3773018800001",
    "datetime": "2023-07-27 15:02:30",
    "code": "ADC3470652601206",
    "uid": "",
    "organization_id": "",
    "project_uid": "adap1",
    "object_id": "yjj",
    "Start": "2023-07-27T15:02:20.1837812+08:00",
    "End": "2023-07-27T15:02:30.1837812+08:00"
}

1.2. 特征统计接口

1.2.1. 全局公共参数

1.2.1.1. 全局Header参数

参数名 示例值 参数描述
暂无参数

1.2.1.2. 全局Query参数

参数名 示例值 参数描述
暂无参数

1.2.1.3. 全局Body参数

参数名 示例值 参数描述
暂无参数

1.2.1.4. 全局认证方式

noauth

1.2.1.5. 全局预执行脚本

暂无预执行脚本

1.2.1.6. 全局后执行脚本

暂无后执行脚本

1.2.2. /特征统计

暂无描述

1.2.2.1. Header参数

参数名 示例值 参数描述
暂无参数
#### 1.2.2.2. Query参数
参数名 示例值 参数描述
— — —
暂无参数
#### 1.2.2.3. Body参数
参数名 示例值 参数描述
— — —
暂无参数
#### 1.2.2.4. 认证方式
`text
noauth
`
#### 1.2.2.5. 预执行脚本
`javascript
暂无预执行脚本
`
#### 1.2.2.6. 后执行脚本
`javascript
暂无后执行脚本
`
### 1.2.3. /特征统计/创建
`text
暂无描述
`
#### 1.2.3.1. 接口状态
> 已完成

1.2.3.2. 接口URL

http://127.0.0.1:6061/api

1.2.3.3. 请求方式

POST

1.2.3.4. Content-Type

json

1.2.3.5. 请求Body参数

{
    "action":"create_adaps_summary",
    "name": "s1",
    "alias": "s1",
    "description":"qqq",
    "project_uid": "ADP3182965100002",
    "frequency": 1,
    "duration": 10
}
参数名 示例值 参数类型 是否必填 参数描述
action create_adaps_summary String 是 -
name s1 String 是 名称
alias s1 String 否 别名
description qqq String 是 描述
project_uid ADP3182965100002 String 是 特征项目编号
frequency 1 Number 是 统计频次（小时/次）
duration 180 Number 是 统计周期(天)
#### 1.2.3.6. 认证方式
`text
noauth
`
#### 1.2.3.7. 预执行脚本
`javascript
暂无预执行脚本
`
#### 1.2.3.8. 后执行脚本
`javascript
暂无后执行脚本
`
#### 1.2.3.9. 成功响应示例
`javascript
{
“resp”: “create_adaps_summary”,
“code”: 200,
“msg”: “成功”,
“result”: {
“id”: 2,
“organization_id”: “”,
“uid”: “SMY3100708600007”,
“name”: “s1”,
“alias”: “s1”,
“project_uid”: “ADP3182965100002”,
“object_id”: “yjj”,
“frequency”: 1,
“duration”: 10,
“run_time”: “0001-01-01T00:00:00Z”,
“last_exec_time”: “0001-01-01T00:00:00Z”,
“description”: “qqq”,
“is_available”: 0,
“created_by”: 0,
“last_modified_by”: 0,
“created”: “”,
“last_modified”: “”
}
}
`
参数名 示例值 参数类型 参数描述
— — — —
resp create_adaps_summary String -
code 200 Number -
msg 成功 String 返回文字描述
result - Object 结果集
result.id 2 Number -
result.organization_id - Object -
result.uid SMY3100708600007 String -
result.name s1 String 名称
result.alias s1 String 别名
result.project_uid ADP3182965100002 String 特征项目编号
result.object_id yjj String -
result.frequency 1 Number 统计频次（小时/次）
result.duration 10 Number 统计周期(天)
result.run_time 0001-01-01T00:00:00Z String -
result.last_exec_time 0001-01-01T00:00:00Z String -
result.description qqq String 描述
result.is_available - Number -
result.created_by - Number -
result.last_modified_by - Number -
result.created - Object -
result.last_modified - Object -

1.2.4. /特征统计/编辑

暂无描述

1.2.4.1. 接口状态

已完成

1.2.4.2. 接口URL

http://127.0.0.1:6061/api

1.2.4.3. 请求方式

POST

1.2.4.4. Content-Type

json

1.2.4.5. 请求Body参数

{
    "action":"update_adaps_summary",
    "uid": "SMY3100708600007",
    "name": "s1",
    "alias": "s1",
    "description":"qqq",
    "project_uid": "ADP3182965100002",
    "frequency": 1,
    "duration": 10
}
参数名 示例值 参数类型 是否必填 参数描述
action update_adaps_summary String 是 -
uid SMY3100708600007 String 是 编号
name s1 String 是 名称
alias s1 String 是 别名
description qqq String 是 描述
project_uid ADP3182965100002 String 是 特征项目编号
frequency 1 Number 是 统计频次（小时/次）
duration 10 Number 是 统计周期(天)
#### 1.2.4.6. 认证方式
`text
noauth
`
#### 1.2.4.7. 预执行脚本
`javascript
暂无预执行脚本
`
#### 1.2.4.8. 后执行脚本
`javascript
暂无后执行脚本
`
#### 1.2.4.9. 成功响应示例
`javascript
{
“resp”: “update_adaps_summary”,
“code”: 200,
“msg”: “成功”,
“result”: {
“id”: 2,
“organization_id”: “”,
“uid”: “SMY3100708600007”,
“name”: “s1”,
“alias”: “s1”,
“project_uid”: “ADP3182965100002”,
“object_id”: “yjj”,
“frequency”: 1,
“duration”: 10,
“run_time”: null,
“last_exec_time”: null,
“description”: “qqq”,
“is_available”: 0,
“created_by”: 0,
“last_modified_by”: 0,
“created”: “”,
“last_modified”: “”
}
}
`
参数名 示例值 参数类型 参数描述
— — — —
resp update_adaps_summary String -
code 200 Number -
msg 成功 String 返回文字描述
result - Object 结果集
result.id 2 Number -
result.organization_id - Object -
result.uid SMY3100708600007 String 编号
result.name s1 String 名称
result.alias s1 String 别名
result.project_uid ADP3182965100002 String 特征项目编号
result.object_id yjj String -
result.frequency 1 Number 统计频次（小时/次）
result.duration 10 Number 统计周期(天)
result.run_time - Object -
result.last_exec_time - Object -
result.description qqq String 描述
result.is_available - Number -
result.created_by - Number -
result.last_modified_by - Number -
result.created - Object -
result.last_modified - Object -

1.2.5. /特征统计/启动

暂无描述

1.2.5.1. 接口状态

已完成

1.2.5.2. 接口URL

http://127.0.0.1:6061/api

1.2.5.3. 请求方式

POST

1.2.5.4. Content-Type

json

1.2.5.5. 请求Body参数

{
    "action":"start_adaps_summary",
    "uid": "SMY3100708600007"
}

1.2.5.6. 认证方式

noauth

1.2.5.7. 预执行脚本

暂无预执行脚本

1.2.5.8. 后执行脚本

暂无后执行脚本

1.2.6. /特征统计/停止

暂无描述

1.2.6.1. 接口状态

已完成

1.2.6.2. 接口URL

http://127.0.0.1:6061/api

1.2.6.3. 请求方式

POST

1.2.6.4. Content-Type

json

1.2.6.5. 请求Body参数

{
    "action":"stop_adaps_summary",
    "uid": "SMY3100708600007"
}

1.2.6.6. 认证方式

noauth

1.2.6.7. 预执行脚本

暂无预执行脚本

1.2.6.8. 后执行脚本

暂无后执行脚本

1.2.7. /特征统计/获取详情

暂无描述

1.2.7.1. 接口状态

已完成

1.2.7.2. 接口URL

http://127.0.0.1:6061/api

1.2.7.3. 请求方式

POST

1.2.7.4. Content-Type

json

1.2.7.5. 请求Body参数

{
    "action":"get_adaps_summary_item",
    "uid": "SMY3100708600007"
}

1.2.7.6. 认证方式

noauth

1.2.7.7. 预执行脚本

暂无预执行脚本

1.2.7.8. 后执行脚本

暂无后执行脚本

1.2.7.9. 成功响应示例

{
    "resp": "get_adaps_summary_item",
    "code": 200,
    "msg": "成功",
    "result": {
        "id": 2,
        "organization_id": "",
        "uid": "SMY3100708600007",
        "name": "s1",
        "alias": "s1",
        "project_uid": "ADP3182965100002",
        "object_id": "yjj",
        "frequency": 1,
        "duration": 10,
        "run_time": "2023-11-30T15:32:57.308+08:00",
        "last_exec_time": "2023-11-30T15:32:57.308+08:00",
        "description": "qqq",
        "is_available": 0,
        "created_by": 0,
        "last_modified_by": 0,
        "created": "2023-11-30 15:23:07",
        "last_modified": "2023-11-30 15:33:41"
    }
}

1.2.8. /特征统计/获取列表

暂无描述

1.2.8.1. 接口状态

已完成

1.2.8.2. 接口URL

http://127.0.0.1:6061/api

1.2.8.3. 请求方式

POST

1.2.8.4. Content-Type

json

1.2.8.5. 请求Body参数

{
    "action":"get_adaps_summary_list",
    "page_index": 1,
    "page_size": 10
}

1.2.8.6. 认证方式

noauth

1.2.8.7. 预执行脚本

暂无预执行脚本

1.2.8.8. 后执行脚本

暂无后执行脚本

1.2.9. /特征统计/获取结果列表

暂无描述

1.2.9.1. 接口状态

已完成

1.2.9.2. 接口URL

http://127.0.0.1:6061/api

1.2.9.3. 请求方式

POST

1.2.9.4. Content-Type

json

1.2.9.5. 请求Body参数

{
    "action":"get_adaps_summary_result_list",
    "page_index": 1,
    "page_size": 10
}

1.2.9.6. 认证方式

noauth

1.2.9.7. 预执行脚本

暂无预执行脚本

1.2.9.8. 后执行脚本

暂无后执行脚本

1.2.9.9. 成功响应示例

{
    "resp": "get_adaps_summary_result_list",
    "code": 200,
    "msg": "成功",
    "result": {
        "page_index": 1,
        "page_size": 10,
        "total_pages": 3,
        "total_records": 21,
        "data": [
            {
                "id": 67,
                "uid": "SMR3211159700021",
                "organization_id": "ORGANIZATION1658222117234135",
                "project_uid": "ADP3182965100002",
                "summary_uid": "rt",
                "object_id": "yjj",
                "has_run_time": 143362,
                "count": 0,
                "total_time": 0,
                "average_time": 0,
                "max_time": 0,
                "min_time": 0,
                "created": "2023-12-01 09:22:11"
            }
        ]
    }
}
参数名 示例值 参数类型 参数描述
resp get_adaps_summary_result_list String -
code 200 Number -
msg 成功 String 返回文字描述
result - Object 结果集
result.page_index 1 Number -
result.page_size 10 Number -
result.total_pages 3 Number -
result.total_records 21 Number -
result.data - Object 返回数据
result.data.id 67 Number -
result.data.uid SMR3211159700021 String 编号
result.data.organization_id ORGANIZATION1658222117234135 String -
result.data.project_uid ADP3182965100002 String 特征项目编号
result.data.summary_uid rt String 特征统计编号
result.data.object_id yjj String 对象编号
result.data.has_run_time 143362 Number 已统计时长，单位：秒
result.data.count - Number 总次数
result.data.total_time - Number 总持续时长
result.data.average_time - Number 平均持续时长
result.data.max_time - Number 最大持续时长
result.data.min_time - Number 最短持续时长
result.data.created 2023-12-01 09:22:11 String -
文档更新时间: 2024-04-12 17:57   作者：技术支持