文档首页> 园区智能体 CampusGo> API参考> 边缘服务API> 边缘烟火检测> 创建边缘烟火检测作业

更新时间：2022-03-17 GMT+08:00

查看PDF

创建边缘烟火检测作业

功能介绍

该API可分析边缘摄像头输出的RTSP视频流。提供了烟和火检测功能。当出现烟或者火时，会上报告警信息。

目前支持H264、H265编码格式的RTSP视频流。

调试

您可以在API Explorer中调试该接口。

URI

URI格式

POST /v2/{project_id}/services/c-smoke-and-fire-edge/tasks

参数说明

参数	是否必选	类型	说明
project_id	是	String	服务所在区域对应的项目ID，获取方法请参见获取项目ID。

请求

请求样例1（摄像头输入+DIS/Webhook输出）

POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-smoke-and-fire-edge/tasks
{
    "name": "smoke-and-fire-edge-task",
    "description": "smoke-and-fire-edge-task",
    "input": {
        "type": "edgecamera",
        "data": [
            {
                "id": "aec5857c-222f-4aa9-be39-23654e118886",
                "index": 0
            }
        ]
    },
    "output": {
        "dis": {
            "stream_name": "dis-smoke-and-fire-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": {
            "image_compression_ratio": 90,
            "render_result_sw": 1,
            "video_sampling_interval": 1,
            "target_roi": "{\"polygons\":[{\"data\":[[204,64],[90,321],[511,319],[617,221],[582,38],[320,11],[228,24]]}]}",
            "render_roi_sw": 1,
            "fire_detection_sw": 1,
            "smoke_detection_sw": 1
        }
   }
}

请求样例2（edgerestful输入+DIS/Webhook输出）

POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-smoke-and-fire-edge/tasks
{
    "name": "smoke-and-fire-edge-task",
    "description": "smoke-and-fire-edge-task",
    "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-smoke-and-fire-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": {
            "image_compression_ratio": 90,
            "render_result_sw": 1,
            "video_sampling_interval": 1,
            "target_roi": "{\"polygons\":[{\"data\":[[204,64],[90,321],[511,319],[617,221],[582,38],[320,11],[228,24]]}]}",
            "render_roi_sw": 1,
            "fire_detection_sw": 1,
            "smoke_detection_sw": 1
        }
   }
}

请求样例3（VCN输入+DIS/Webhook输出）

POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-smoke-and-fire-edge/tasks
{
    "name": "smoke-and-fire-edge-task",
    "description": "smoke-and-fire-edge-task",
    "input": {
        "type": "vcn",
        "vcn":{
                "ip":"172.100.119.6",
                "password":"CQeNfcRLwyMvH77AkDBaPS+BKXdFu/1bAXtIMNTx3QPbVewjipNq06nNodxWI28I1lCUsvv2+wB1joepzynLVW3g2nz0k9vaCRDoK6=",
                "port":"4675",
                "username":"testname"
        },
        "data": [
            {
                "index": 0,
                "device_id":"07211540881586160101#f7964493ff764bbf9294d58b22e63de6",
                "stream_type": 1
            }
        ]
    },
    "output": {
        "dis": {
            "stream_name": "dis-smoke-and-fire-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": {
            "image_compression_ratio": 90,
            "render_result_sw": 1,
            "video_sampling_interval": 1,
            "target_roi": "{\"polygons\":[{\"data\":[[204,64],[90,321],[511,319],[617,221],[582,38],[320,11],[228,24]]}]}",
            "render_roi_sw": 1,
            "fire_detection_sw": 1,
            "smoke_detection_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参数说明

字段	是否必选	类型	说明
image_compression_ratio	否	Int	对应控制台的界面参数“图片压缩比”。图片压缩百分比，取值范围为[20，100]。默认值：90，表示图片压缩比为90%。
render_result_sw	否	Int	对应控制台的界面参数“检测结果渲染开关”。输出图像是否绘制告警目标边框，取值范围: "0"：表示不绘制； "1"：表示当告警为烟时，用紫色绘制告警目标框；当告警为火时，用红色绘制告警目标框。默认值为0。
video_sampling_interval	否	Int	对应控制台的界面参数“视频采样间隔时间”。单位秒，默认值: 1，取值范围[1, 10]。注意：此参数决定了算法检测的频率，时间间隔增加，烟或火从发生到检测的最大时延会增加，建议根据可接受的实际响应延时设置此参数。
target_roi	否	String	对应控制台的界面参数“检测区域设置”。表示检测区域，该字段为JSON格式的字符串，API调用时需要加转义符。详细JSON格式参见target_roi（目标区域）。例如： {"polygons":[{"data":[[0,0],[0,1080],[1920,1080],[1920,0]]}]} 参数没有携带时，默认区域为整个视频帧。
render_roi_sw	否	Int	对应控制台的界面参数“检测区域渲染开关”。输出图像是否绘制检测区域，取值范围: "0"：表示不绘制。 "1"：表示用黄色绘制用户设定区域。默认值为0。
fire_detection_sw	否	Int	对应控制台的界面参数“明火检测开关”。是否检测明火，取值范围： "0"：表示关闭。 "1"：表示开启。默认值为1。
smoke_detection_sw	否	Int	对应控制台的界面参数“烟雾检测开关”。是否检测烟雾，取值范围： "0"：表示关闭。 "1"：表示开启。默认值为1。

响应

响应样例

[
  { 
    "id": "2f268b9472a544e991eae3c5c3534f5b"
  }
]

返回作业ID列表

参数

类型

说明

id

String

作业ID。

参数	类型	说明
id	String	作业ID。

检测结果

输出JSON数据流到DIS指定的通道或者Webhook URL，包括告警结构化数据和图片数据。

JSON结果示例：

{
    "event_type": 393216,
    "task_id": "2f268b9472a544e991eae3c5c3534f5b",
    "stream_id": "b664d367-3bf4-4d94-969f-b877d8c5d9ae",
    "timestamp": 1558645124,
    "message_id": "82C02174-4FEB-11EA-9357-407D0FAD91FC",
    "image_base64": "/9j/4AAQSkZJRgABAQAAAQABAAD/",
    "data": {
        "event_set": [
            {
                "state": 2,
                "bounding_box": {
                    "x": 27,
                    "y": 0,
                    "w": 115,
                    "h": 115
                }
            }
        ]
    }
}

JSON格式说明

字段	类型	说明
stream_id	String	摄像头编号。
event_type	Uint64	快速标识烟火检测的输出消息类型。烟火检测算法其值固定为393216，对应16进制为 0x 0000 0000 0006 0000。
task_id	String	作业ID。
timestamp	Uint64	触发告警时间点的时间戳。
message_id	String	告警ID，生成的唯一告警事件UUID。
data	Object	业务输入内容。
image_base64	String	告警时刻输入的视频图像的Base64编码结果。

data参数格式说明

字段

类型

说明

event_set

List<Object>

输出事件列表。

字段	类型	说明
event_set	List<Object>	输出事件列表。

event_set参数格式说明

字段	类型	说明
bounding_box	Object	告警输出的烟火对象矩形框。
state	Int	烟火告警的类型： 1：火 2：烟

bounding_box格式说明

字段	类型	说明
x	Int	矩形框左上角横坐标。
y	Int	矩形框左上角纵坐标。
w	Int	矩形框宽度。
h	Int	矩形框高度。

返回值

正常
 201

异常

返回值	说明
400 Bad Request	请求错误，具体返回错误码请参考错误码。
401 Unauthorized	鉴权失败。
403 Forbidden	没有操作权限。
404 Not Found	找不到资源。
500 Internal Server Error	服务内部错误。
503 Service Unavailable	服务不可用。

父主题： 边缘烟火检测

上一篇：边缘烟火检测

下一篇：查询作业列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建边缘烟火检测作业

功能介绍

调试

URI

请求

响应

检测结果

返回值

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线