文档首页/ 视频智能分析服务 VIAS/ API参考/ 算法API/ 边缘服务API/ 创建边缘烟火检测作业

更新时间：2024-09-25 GMT+08:00

查看PDF

创建边缘烟火检测作业

功能介绍

该接口用于创建边缘烟火检测作业。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	用户项目ID。获取方法参见获取项目ID和名称。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，获取方法参见认证鉴权。

表3 请求Body参数
参数	是否必选	参数类型	描述
name	是	String	作业名称，只能由中文、字母（a～z A～Z）、数字（0～9）、中划线（-）、下划线（_）组成，长度范围为[1，100]。
description	否	String	作业描述信息，最大长度为500字符长度。最小长度：0 最大长度：500
schedule	否	TaskSchedule object	定时任务参数，定时周期仅支持周模式。
input	是	TaskInput object	作业的输入配置。
output	是	TaskOutput object	作业的输出配置，至少需要配置一项输出方式。
config	否	SmokeAndFireServiceConfig object	作业配置参数。
service_version	是	String	服务版本号，输入需要满足正则：^[a-z0-9.]{3,32}$。最小长度：3 最大长度：32
is_saved_as_template	否	Boolean	是否把作业配置保存成模板。
resource_order_id	否	String	资源订单id，与关联算法挂钩。非商用白名单的算法就不用填，商用算法就为必填项，需要满足正则表达式^[a-z0-9-_]{4,36}$。最小长度：4 最大长度：36

表4 TaskSchedule
参数	是否必选	参数类型	描述
type	是	String	计划任务的类型，使用计划任务时必填。可选类型分别为weekly（每周执行），monthly（每月执行）。
timezone	是	String	用户所处的时区，使用计划任务时必填。精确到分钟。
days_of_week	否	Array of integers	作业会在一周的哪几天执行，当且仅当计划任务类型为weekly时，该字段需填且必填。1~7分别指代星期一至星期日。最小值：1 最大值：7 数组长度：1 - 7
days_of_month	否	Array of integers	作业会在一个月的哪几天执行，当且仅当计划任务类型为monthly时，该字段需填且必填。1~31分别指代一个月中的1日至31日。最小值：1 最大值：31
periods	否	Array<Array<>>	时间段模式配置，指定周计划或者月计划中具体每天作业的执行时间段，至少需指定一个时间段。

表5 TaskInput
参数	是否必选	参数类型	描述
type	是	String	作业的输入类型，创建时必填，编辑时video_source 模式不支持切换为其他IVA模式的type。创建时可选类型有 obs（对象存储服务存储的文件仅云上作业支持）， url（指定的文件地址或取流地址仅云上作业支持）， edgecamera（绑定在IEF的边缘摄像头仅边缘作业支持）, restful（从自定义的流媒体服务器通过Restful接口获取取流地址云上，边缘均作业支持）， vcn（VCN设备仅边缘作业支持）, video_source（视频源类型），建议使用video_source类型，其他类型为了兼容老业务，后续将废弃。枚举值： video_source obs(不建议使用，后续废弃) url(不建议使用，后续废弃) edgecamera(不建议使用，后续废弃) restful(不建议使用，后续废弃) vcn(不建议使用，后续废弃)
data	是	Array of TaskInputData objects	作业的输入详情，必填。针对不同的输入类型有不同的配置。创建时允许填写多路输入，但更新时只允许填写一路输入。当输入类型为：obs，需要配置 bucket，path ， index 。例如： "bucket": "aicam", "path": "3rdpartylicenses.txt", "index": 0 当输入类型为：url，需要配置 url， index 。例如： "url": "https://xxx-xxx.com", "index": 0 当输入类型为：restful，需要配置 certificate_check， rtsp_path_in_response， url， index， headers 。例如："certificate_check": true, "url": "https://hsaij-dasahbi.com", "rtsp_path_in_response": "data/url", "index": 0, "headers": { "AAA": "AAA" } 当输入类型为：vcn，需要配置 device_id， stream_type， index。例如："device_id": "21356478954612546874#gdhjkiushdgdksjhslmhscjsckjhdbnk", "stream_type": 1, "index": 0 当输入类型为：EdgeCamera，需要配置 id， index 例如："id": "007cdafc-6000-47ce-b0e3-870b4a0db65e","index": 0 数组长度：1 - 50
vcn	否	TaskInputVcn object	VCN服务器信息，仅输入类型为vcn时必填。

表6 TaskInputData
参数	是否必选	参数类型	描述
video_source_id	否	String	视频源id，当输入类型为video_source时必填。
stream_name	否	String	视频流名称。
bucket	否	String	OBS桶名，当输入为obs类型时必填。最大长度：63
path	否	String	OBS的路径，当输入为obs类型时必填。最大长度：1023
url	否	String	url输入源的地址或者获取视频流地址的restful请求地址，当输入为url类型或者edgerestful类型时必填。长度不超过1000。最大长度：1000
headers	否	Object	获取视频流地址的restful请求携带的请求头，当输入为edgerestful类型时可选。整体呈json格式，以键值对的形式表示请求头和取值，最多允许10组。
certificate_check	否	Boolean	是否需要对https请求进行证书校验，当输入为edgerestful类型时必填。取值为true或者false。
rtsp_path_in_response	否	String	restful请求返回的body中，视频流地址的路径，当输入为edgerestful类型时必填。长度不超过1024。最大长度：1024
device_id	否	String	VCN设备ID，当输入为vcn类型时必填。
stream_type	否	Integer	准备进行分析的码流，当输入为vcn类型时选填。取值范围为1~3，其中1代表主码流，2代表子码流1，3代表子码流2。最小值：1 最大值：3
id	否	String	IEF挂载的边缘设备的ID，当输入为edgecamera类型时必填。最大长度：63

表7 TaskInputVcn
参数	是否必选	参数类型	描述
ip	是	String	VCN服务器的IP地址，仅输入类型为vcn时必填。
port	是	Integer	VCN服务器的端口号，仅输入类型为vcn时必填。最小值：0 最大值：65535
username	是	String	VCN服务器的账号名，仅输入类型为vcn时需填且必填,需要满足正则表达式^.{1,100}$。
password	是	String	VCN服务器的与账号对应的密码，仅输入类型为vcn时必填，需要满足正则表达式^.{1,1000}$。

表8 TaskOutput
参数	是否必选	参数类型	描述
obs	否	TaskOutputObs object	输出为obs类型时的配置信息。
dis	否	TaskOutputDis object	输出为dis类型时的配置信息。
webhook	否	TaskOutputWebhook object	输出为webhook类型时的配置信息。
event_center	否	Boolean	是否把告警发送至事件中心，云上作业该字段有效。缺省值：false

表9 TaskOutputObs
参数	是否必选	参数类型	描述
bucket	是	String	OBS桶名，选用obs类型输出时必填，校验规则：(pattern:“^[a-z0-9](?!.[-.][-.].)([a-z0-9-.]{1,61})[a-z0-9]$”)。最大长度：63
path	是	String	OBS的路径，选用obs类型输出时必填，校验规则：^(?![/.\s])(?!.//.)([^:?"<>\|]{0,1023})(?<![.\s])$。最大长度：1023*
data_category	否	Array of strings	作业输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据。数组长度：0 - 10

**表10** TaskOutputDis
参数	是否必选	参数类型	描述
stream_name	是	String	DIS流名称，选用dis类型输出时必填。最大长度：64
data_category	否	Array of strings	作业输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据。数组长度：0 - 10

**表11** TaskOutputWebhook
参数	是否必选	参数类型	描述
url	是	String	结果回调地址，选用webhook类型输出时必填。最大长度：1000
headers	是	Object	结果回调时需要携带的请求头，选用webhook类型输出时必填。整体呈json格式，以键值对的形式表示请求头和取值，至少1组，至多10组。
data_category	否	Array of strings	作业输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据。数组长度：0 - 10

**表12** SmokeAndFireServiceConfig
参数	是否必选	参数类型	描述
common	否	SmokeAndFireCommon object	作业运行时指定的具体的自定义配置项，由服务发布者定义。整体呈json格式，具体配置项参见相应算法服务的说明。

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

响应参数

状态码： 200

**表14** 响应Body参数
参数	参数类型	描述
tasks	Array of TaskResponse objects	VIAS平台创建作业的作业id列表

**表15** TaskResponse
参数	参数类型	描述
id	String	VIAS平台创建的作业id。

状态码： 400

**表16** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息描述。
detail	String	错误详情。
params	Array of strings	错误参数列举。数组长度：0 - 1
reason	String	错误原因。
advice	String	建议。

状态码： 500

**表17** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息描述。
detail	String	错误详情。
params	Array of strings	错误参数列举。数组长度：0 - 1
reason	String	错误原因。
advice	String	建议。

请求示例

边缘烟火检测作业创建，使用输入源为video_source，输出为webhook。

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

{
  "name" : "fireandsmoke-detection-task",
  "description" : "fireandsmoke detection task test",
  "input" : {
    "type" : "video_source",
    "data" : [ {
      "video_source_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx"
    } ]
  },
  "output" : {
    "webhook" : {
      "url" : "https://127.0.0.1:8080/webhook",
      "headers" : {
        "x-auth-token" : "tokentest"
      }
    }
  },
  "service_version" : "3.0",
  "resource_order_id" : "840a5cf90d4a4bbaa71f251dfe8fe64e",
  "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
    }
  }
}

边缘烟火检测作业创建，使用输入源为vcn，输出为dis。

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

{
  "name" : "fireandsmoke-detection-task",
  "description" : "fireandsmoke detection task test",
  "input" : {
    "type" : "vcn",
    "data" : [ {
      "device_id" : "aec5857c-222f-4aa9-be39-23654e118886",
      "stream_type" : 2
    } ],
    "vcn" : {
      "ip" : "127.0.0.1",
      "port" : 8080,
      "username" : "vcntest",
      "password" : "123456abcd"
    }
  },
  "output" : {
    "dis" : {
      "stream_name" : "dis-test"
    }
  },
  "service_version" : "3.0",
  "resource_order_id" : "840a5cf90d4a4bbaa71f251dfe8fe64e",
  "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
    }
  }
}

边缘烟火检测作业创建，使用输入源为边缘摄像头，输出为dis。

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

{
  "name" : "fireandsmoke-detection-task",
  "description" : "fireandsmoke detection task test",
  "input" : {
    "type" : "edgecamera",
    "data" : [ {
      "id" : "aec5857c-222f-4aa9-be39-23654e118886",
      "index" : 0
    } ]
  },
  "output" : {
    "dis" : {
      "stream_name" : "dis-test"
    }
  },
  "service_version" : "3.0",
  "resource_order_id" : "840a5cf90d4a4bbaa71f251dfe8fe64e",
  "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
    }
  }
}

边缘烟火检测作业创建，使用输入源为restful，输出为webhook。

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

{
  "name" : "fireandsmoke-detection-task",
  "description" : "fireandsmoke detection task test",
  "input" : {
    "type" : "restful",
    "data" : [ {
      "url" : "https://restfultest",
      "certificate_check" : false,
      "node_id" : "aec5857c-222f-4aa9-be39-23654e118886",
      "rtsp_path_in_response" : "http://testpath"
    } ]
  },
  "output" : {
    "webhook" : {
      "url" : "https://127.0.0.1:8080/webhook",
      "headers" : {
        "x-auth-token" : "tokentest"
      }
    }
  },
  "service_version" : "3.0",
  "resource_order_id" : "840a5cf90d4a4bbaa71f251dfe8fe64e",
  "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
    }
  }
}

响应示例

状态码： 200

创建服务作业成功。

{
  "tasks" : [ {
    "id" : "20690c67d71549c39085a3b28c18f24f"
  } ]
}

状态码

状态码	描述
200	创建服务作业成功。
400	请求错误。
500	内部错误。

错误码

请参见错误码。

父主题： 边缘服务API

上一篇：创建边缘工服工帽检测作业

下一篇：创建边缘打架检测作业

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问

创建边缘烟火检测作业

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

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

7*24

备案

专业服务

退订

建议反馈

售前咨询热线