创建边缘遗留物检测作业
功能介绍
该API可分析边缘摄像头输出的RTSP视频流,提供了遗留物检测功能。当视频流中检测到遗留物时,会上报告警信息。
- 目前支持H264、H265编码格式的RTSP视频流。
调试
您可以在API Explorer中调试该接口。
URI
- URI格式
POST /v2/{project_id}/services/c-abandon-detection-edge/tasks
- 参数说明
参数
是否必选
类型
说明
project_id
是
String
服务所在区域对应的项目ID,获取方法请参见获取项目ID。
请求
- 请求样例1(摄像头输入+DIS/Webhook输出)
POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-abandon-detection-edge/tasks { "name": "abandon-detection-edge-task", "description": "Abandon Detection task test", "input": { "type": "edgecamera", "data": [ { "id": "aec5857c-222f-4aa9-be39-23654e118886", "index": 0 } ] }, "output": { "dis": { "stream_name": "dis-abandondetection-edge" }, "webhook": { "url": "https://apigw.huawei.com/api/event/callback", "headers": { "content-type": "application/json" } } }, "service_version": "3.0", "resource_order_id": "840a5cf90d4a4bbaa71f251dfe8fe64e", "edge_pool_id": "8dcf5ec7bc4d4a26aa1d3e1bb5ed2b5a", "service_config": { "common": { "detection_min_size": 50, "alert_time_threshold": 10, "alert_detection_interval": 5, "image_compression_ratio": 80, "target_roi": "{\"polygons\":[{\"data\":[[84,389],[1840,349],[1824,526],[78,526]]}]}", "render_result_sw": 1, "render_roi_sw": 1 } } }
- 请求样例2(edgerestful输入+DIS/Webhook输出)
POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-abandon-detection-edge/tasks { "name": "abandon-detection-edge-task", "description": "Abandon Detection task test", "input": { "type": "edgerestful", "data": [ { "index": 0, "url":"https://100.127.134.69:554/test/data", "certificate_check": false, "rtsp_path_in_response": "data/url" } ] }, "output": { "dis": { "stream_name": "dis-abandondetection-edge" }, "webhook": { "url": "https://apigw.huawei.com/api/event/callback", "headers": { "content-type": "application/json" } } }, "service_version": "3.0", "resource_order_id": "840a5cf90d4a4bbaa71f251dfe8fe64e", "edge_pool_id": "8dcf5ec7bc4d4a26aa1d3e1bb5ed2b5a", "service_config": { "common": { "detection_min_size": 50, "alert_time_threshold": 10, "alert_detection_interval": 5, "image_compression_ratio": 80, "target_roi": "{\"polygons\":[{\"data\":[[84,389],[1840,349],[1824,526],[78,526]]}]}", "render_result_sw": 1, "render_roi_sw": 1 } } }
- 请求样例3(VCN输入+DIS/Webhook输出)
POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-abandon-detection-edge/tasks { "name": "abandon-detection-edge-task", "description": "Abandon Detection task test", "input": { "type": "vcn", "vcn": { "ip":"172.100.119.6", "password":"CQeNfcRLwyMvH77AkDBaPS+BKXdFu/1bAXtIMNTx3QPbVewjipNq06nNodxWI28I1lCUsvv2+wB1joepzynLVW3g2nz0k9vaCRDoK6=", "port":"4675", "username":"testname" }, "data": [ { "index": 0, "stream_type": 1, "device_id":"07211540881586160101#f7964493ff764bbf9294d58b22e63de6" } ] }, "output": { "dis": { "stream_name": "dis-abandondetection-edge" }, "webhook": { "url": "https://apigw.huawei.com/api/event/callback", "headers": { "content-type": "application/json" } } }, "service_version": "3.0", "resource_order_id": "840a5cf90d4a4bbaa71f251dfe8fe64e", "edge_pool_id": "8dcf5ec7bc4d4a26aa1d3e1bb5ed2b5a", "service_config": { "common": { "detection_min_size": 50, "alert_time_threshold": 10, "alert_detection_interval": 5, "image_compression_ratio": 80, "target_roi": "{\"polygons\":[{\"data\":[[84,389],[1840,349],[1824,526],[78,526]]}]}", "render_result_sw": 1, "render_roi_sw": 1 } } }
- 参数说明
参数
是否必选
类型
说明
name
是
String
作业名称,只能由中文、字母(a~zA~Z)、数字(0~9)、中划线(-)、下划线(_)组成,长度范围为[1,100]。
description
否
String
作业描述信息,最大长度为500字符长度。
input
是
Object
视频数据输入列表,支持从指定的边缘摄像头读取数据,即输入类型为“edgecamera”,“edgerestful”,“VCN”。
详细参数定义参见task.input(任务输入参数)。
service_version
是
String
功能版本号,版本号为3.0。边缘算法版本支持的显卡硬件为T4和华为自研Davinci芯片。
resource_order_id
是
String
购买的算法能力包ID,在服务界面购买算法能力包获取。
edge_pool_id
是
String
边缘运行池ID,获取方法参见创建边缘运行池。
output
是
Object
结果数据的输出列表,目前支持以下输出类型:- DIS:将结果输出到您指定的DIS通道 。
- Webhook:将结果输出到Webhook URL。
- Localpath:将作业的运行结果保存在边缘节点本地(节点必须为linux系统),必须为linux路径,例如“/opt/cloud/”。
详细参数定义见task.output(任务输出参数)。
service_config
否
Object
服务的算法配置,配置参数见•service_config参数说明。
- service_config中common参数说明
字段
是否必选
类型
说明
detection_min_size
否
Int
对应控制台的界面参数“检测目标最小像素值”。
检测目标的长宽最小像素值,与分辨率成正比,在1080p分辨率下,取值范围为[50, 400],默认值为50。
alert_time_threshold
否
Int
对应控制台的界面参数“告警时间阈值”。
遗留物告警时间阈值,目标产生告警时的遗留时间不少于该时间。
单位为秒,取值范围[10, 300],默认值为10。
alert_detection_interval
否
Int
对应控制台的界面参数“检测周期”。
遗留物告警检测周期。如果在一个周期内有多个告警,则合并为一个告警。
单位为秒,取值范围为[1, 150],默认值为5,建议取值范围为[1, alert_time_threshold/2]。
image_compression_ratio
否
Int
对应控制台的界面参数“图片压缩比”。
图片压缩百分比,取值范围为[20,100]。
默认值:90,表示图片压缩比为90%。
target_roi
否
String
对应控制台的界面参数“检测区域设置”。
表示检测区域,该字段为JSON格式的字符串,API调用时需要加转义符。详细JSON格式参见target_roi(目标区域)。
例如:
{"polygons":[{"data":[[84,389],[1840,349],[1824,526],[78,526]]}]}
参数没有携带时,默认区域为整个视频帧。
render_result_sw
否
Int
对应控制台的界面参数“目标框渲染开关”。
输出图像是否绘制告警目标边框,取值范围:
- "0":表示不绘制。
- "1":表示用红色绘制告警目标边框。
默认值为0。
render_roi_sw
否
Int
对应控制台的界面参数“检测区域渲染开关”。
输出图像是否绘制检测区域,取值范围:
- "0":表示不绘制。
- "1":表示用黄色绘制用户设定区域。
默认值为0。
响应
- 响应样例
[ { "id": "er58hc86e1c44acbae3901b847312edf" } ]
- 返回作业ID列表
参数
类型
说明
id
String
作业ID。
检测结果
- 输出JSON数据流到DIS指定的通道或者Webhook URL,包括告警结构化数据和图片数据。
- JSON结果示例
{ "event_type": 327680, "timestamp":1581753322, "stream_id":"08eeab92-d822-483a-bc60-eb3db54360f7", "message_id":"849D1326-4FC8-11EA-8F73-0242AC110004", "image_base64":"/9j/4AAQSkZJRgA...", "task_id":"d86edc86e1c44acbae3901b8473185f7", "data":{ "event_set":[ { "bounding_box": { "x": 931, "y": 576, "w": 307, "h": 124 }, "target_remaining_time": "10", "detection_id":"83BFC020-4FC8-11EA-9F93-0242AC110004" } ] } }
- JSON格式说明
字段
类型
说明
stream_id
String
摄像头编号。
event_type
Uint64
快速标识遗留物检测服务的输出消息类型,其值固定为327680,对应16进制为 0x 0000 0000 0005 0000。
task_id
String
作业ID。
message_id
String
告警ID,生成的唯一告警事件UUID。
timestamp
Uint64
触发告警时间点的时间戳。
image_base64
String
告警时刻输入的视频图像的Base64编码结果。
data
Object
业务输出内容。
- data参数格式说明
字段
类型
说明
event_set
List<Object>
输出事件列表。
- event_set参数格式说明
字段
类型
说明
bounding_box
Object
告警输出对象的矩形框。
target_remaining_time
Int
目标停留时间,单位为秒。
说明:目标停留时间:目标被检测到至目标上报告警的时间差。
detection_id
String
告警目标对应的UUID。
- bounding_box参数格式说明
字段
类型
说明
x
Int
矩形框左上角横坐标。
y
Int
矩形框左上角纵坐标。
w
Int
矩形框宽度。
h
Int
矩形框高度。
- data参数格式说明
返回值
- 正常
- 异常
返回值
说明
400 Bad Request
请求错误,具体返回错误码请参考错误码。
401 Unauthorized
鉴权失败。
403 Forbidden
没有操作权限。
404 Not Found
找不到资源。
500 Internal Server Error
服务内部错误。
503 Service Unavailable
服务不可用。