华为云用户手册

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

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

响应消息 删除失败时的响应示例 { "error_code": "IVA.0004", "error_msg": "The request param is invalid. parameter [task_id] does not match ^[0-9a-f]{32}|task\\w{8}$."} 响应参数说明 参数名称 描述信息 error_code 错误码。 error_msg 错误信息。

响应消息 删除失败时的响应示例 { "error_code": "IVA.0004", "error_msg": "The request param is invalid. parameter [task_id] does not match ^[0-9a-f]{32}|task\\w{8}$."} 响应参数说明 参数名称 描述信息 error_code 错误码。 error_msg 错误信息。

响应消息 删除失败时的响应示例 { "error_code": "IVA.0004", "error_msg": "The request param is invalid. parameter [task_id] does not match ^[0-9a-f]{32}|task\\w{8}$."} 响应参数说明 参数名称 描述信息 error_code 错误码。 error_msg 错误信息。

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

响应消息 删除失败时的响应示例 { "error_code": "IVA.0004", "error_msg": "The request param is invalid. parameter [task_id] does not match ^[0-9a-f]{32}|task\\w{8}$."} 响应参数说明 参数名称 描述信息 error_code 错误码。 error_msg 错误信息。

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

请求 请求样例1（VIS输入+DIS输出） POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-flowcount-cloud/tasks{ "name":"flowcount_cloud_0", "description":"flowcount task test", "input":{ "type":"vis", "data":[ { "stream_name":"flowcount", "index":0 } ] }, "output":{ "dis":{ "stream_name":"dis-flowcount" } }, "service_version":"3.0", "resource_order_id":"840a5cf90d4a4bbaa71f251dfe8fe64e", "service_config":{ "common":{ "line_count_interval":2, "region_count_interval":2, "line_detection_sw":1, "region_detection_sw":1, "heatmap_detection_sw":0, "heatmap_detection_interval":60, "target_roi":"{\"lines\":[{\"data\":[[560,680],[1185,506]],\"properties\":{\"side1_name\":\"Side1\",\"side2_name\":\"Side2\"}}],\"polygons\":[{\"data\":[[0,0],[0,1080],[1920,1080],[1920,0]]}]}", "heatmap_point_interval":4 } }} 参数说明 参数 是否必选 类型 说明 name 是 String 作业名称，只能由中文、字母（a～zA～Z）、数字（0～9）、中划线（-）、下划线（_）组成，长度范围为[1，100]。 description 否 String 作业描述信息，最大长度为500字符长度。 input 是 Object 视频数据输入列表，目前云上人流量统计支持以下输入类型： vis：从 视频接入服务 中读取视频数据。 详细参数定义参见task.input（任务输入参数）。 service_version 是 String 功能版本号，版本号为3.0。 resource_order_id 是 String 购买的算法能力包ID，在服务界面购买算法能力包获取。 output 是 Object 结果数据的输出列表，目前支持将结果输出到您指定的通道中，输出类型为“dis”。 详细参数定义参见task.output（任务输出参数）。 service_config 否 Object 服务的算法配置，配置参数见ServiceConfig参数说明。 service_config中common参数结构说明 字段 是否必选 类型 说明 line_count_interval 否 Int 过线人流量统计周期，单位为秒，统计的是一段时间的人流量结果。取值范围为(0, 86400]，默认值为2。 region_count_interval 否 Int 区域人流量统计周期，单位为秒，统计的是当前时刻的区域人流量结果。取值范围为(0, 86400]，默认值为2。 line_detection_sw 否 Int 过线人流量统计开关。 0：表示不开启。 1：表示开启。 默认值为1。 region_detection_sw 否 Int 区域人流量统计开关。 0：表示不开启。 1：表示开启。 默认值为1。 target_roi 否 string 对应控制台的界面参数“检测区域设置”。 表示检测区域，该字段为JSON格式的字符串，API调用时需要加转义符。详细JSON格式参见target_roi（目标区域）。 例如： {"lines":[{"data":[[560,680],[1185,506]],"properties":{"side1_name":"Side1","side2_name":"Side2"}}],"polygons":[{"data":[[0,0],[0,1080],[1920,1080],[1920,0]]}]} 参数没有携带时，默认区域为整个视频帧。 直线与区域默认位置如图1所示。 heatmap_detection_sw 否 Int 热力图检测开关 0：表示不开启。 1：表示开启。 默认值为0。 heatmap_detection_interval 否 Int 热力图检测周期，单位为秒。取值范围为[10, 86400]，默认值为10。依据热力图检测周期内的热点值进行更新。 heatmap_point_interval 否 Int 热点更新周期，单位为帧。取值范围为[1, 10000]，默认值为4。在热力图检测周期内，热点值逐渐累加。 当target_roi参数未设置时，或者线与区域的坐标值全为0时，直线与区域默认位置如图1所示，其中Wframe为帧宽度，Hframe为帧高度。 图1 直线与区域默认位置 直线两端点point_1与point_2默认值为： point_1=(¼Wframe， ½Hframe) point_2=(¾Wframe， ½Hframe) 默认区域为矩形，假设矩形的四个端点分别为point_1、point_2、point_3、point_4，其位置默认为： point_1=(¼Wframe， ¼Hframe) point_2=(¾Wframe， ¼Hframe) point_3=(¼Wframe， ¾Hframe) point_4=(¾Wframe， ¾Hframe)

Token认证 Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中“auth.scope”的取值需要选择“project”，请求示例如下。 { "auth": { "identity": { "methods": ["password"], "password": { "user": { "name": "username", //替换为实际用户名 "password": "**********",//替换为实际的用户密码 "domain": { "name": "domianname" //替换为实际帐号名 } } } }, "scope": { "project": { "name": "cn-north-1 " //替换为实际的project name，获取作用范围为指定project的Token } } }} 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为获取到的Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iva.cn-north-1.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ....

创建边缘运行池 登录视频分析服务管理控制台，在页面左侧导航栏中选择“边缘运行池”。 在“边缘运行池”页面，单击“新增”，创建边缘运行池。 图1 新增边缘运行池 在创建边缘运行池页面配置相关参数。 表1 创建边缘运行池参数说明 参数 参数说明 名称 边缘运行池名称。 只能由中文、英文字母(a~z, A~Z)、数字(0~9)、中划线(-)、下划线(_)组成，长度范围为[1, 100]。 描述 自定义边缘运行池描述信息，以便记忆和区分。 资源类型 目前只支持边缘节点类型。 服务实例ID 可选参数。使用IEF铂金版时，需要先填写服务实例ID，才能绑定相应的边缘节点。 服务实例ID获取请登录智能边缘平台IEF控制台，在总览页面查看铂金版服务示例ID，复制并记录。 边缘节点 选择接入的边缘节点，可以选择多个。 如果还未接入边缘节点，请参考注册边缘节点在智能边缘平台IEF上添加。 容器挂载路径 可选参数。当服务的输出方式选择Local Path时，需要填写容器挂载路径。 此路径必须是在边缘节点上存在的真实路径。用于存储服务检测出来的图片和JSON结构数据，检测的原始图片和JSON结构数据。 服务功能 选择需要在此边缘运行池上运行的算法服务。可以选择多个算法服务。 API标识 选择服务功能后，系统会自动显示该服务对应的API标识。 功能版本 系统会自动选择3.0版本。 最大视频流路数 该算法服务可以接入的最大视频路数，不能超过购买算法包时设置的视频路数。 配置完成后，单击“立即创建”。 可在“边缘运行池”页面查看创建的边缘运行池信息。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

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

响应消息 删除失败时的响应示例 { "error_code": "IVA.0004", "error_msg": "The request param is invalid. parameter [task_id] does not match ^[0-9a-f]{32}|task\\w{8}$."} 响应参数说明 参数名称 描述信息 error_code 错误码。 error_msg 错误信息。

修订记录 发布日期 修改说明 2022-03-16 每个章节中增加在 API Explorer 中调试该接口的链接。 2022-01-13 边缘城管事件-占道经营检测和云上城管事件-占道经营检测API中加入参数repeat_alert_sw、repeat_alert_interval。 2021-12-30 修改创建边缘高密度人群统计检测作业和创建云上高密度人群统计作业中算法的功能介绍。 2021-11-30 边缘高密度人群统计和云上高密度人群统计的输入字段去掉scene_type，并去除全屏模式、Flow模式等相关描述。 2021-10-30 边缘高密度人群统计API中删除Event模式（场景3）相关描述内容。 创建边缘交通流量作业章节中修改参数vehicles为flow_set。 2021-9-30 修改边缘消防通道占用检测和云上消防通道占用API中消防通道告警json语法错误。 2021-08-25 修改云上人流量统计的API标识。c-flowcount-detection改为c-flowcount-cloud 2021-08-16 修改部分参数解释。 2021-05-20 优化错误码说明。 增加边缘垃圾检测API。 2021-04-19 增加占道经营检测API。 2021-02-10 增加云上算法API。 2020-11-26 第一次正式发布。

终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 园区智能体服务的终端节点如表1所示，请您根据业务需要选择对应区域的终端节点。 表1 园区智能体Endpoint 区 域名 称 区域 终端节点（Endpoint） 协议类型 华北-北京一 cn-north-1 iva.cn-north-1.myhuaweicloud.com HTTPS 华北-北京四 cn-north-4 iva.cn-north-4.myhuaweicloud.com HTTPS 华东-上海一 cn-east-1 iva.cn-east-1.myhuaweicloud.com HTTPS 华东-上海二 cn-east-2 iva.cn-east-2.myhuaweicloud.com HTTPS 华南-广州 cn-south-1 iva.cn-south-1.myhuaweicloud.com HTTPS 父主题： 使用前必读

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

响应消息 删除失败时的响应示例 { "error_code": "IVA.0004", "error_msg": "The request param is invalid. parameter [task_id] does not match ^[0-9a-f]{32}|task\\w{8}$."} 响应参数说明 参数名称 描述信息 error_code 错误码。 error_msg 错误信息。

响应 响应样例 {"id": "8656efdafebf440bb7008f174db6c567","name": "queue-status-analysis-edge","creator": "user_test","project_id": "1f793beac00d4801874db741cbfe10fa","description": null,"service_version": "3.0","edge_pool_id": "8dcf5ec7bc4d4a26aa1d3e1bb5ed2b5a", "resource_order_id":"840a5cf90d4a4bbaa71f251dfe8fe64e","created_at": "2020-09-18T03:35:03Z","updated_at": "2020-09-18T03:35:51Z","state": "RUNNING","input": {"type": "edgecamera","data": [{"id": "aec5857c-222f-4aa9-be39-23654e118886","index": 0}]}, "output": { "webhook":{ "url":"https://apigw.xx.com/api/mqs/sit", "headers":{ "content-type":"application/json" } } },"service_config": {"common": {"image_compression_ratio": 90,"render_result_sw": 1,"render_roi_sw": 1,"queue_length_count_sw": 1,"target_roi": "{\"polygons\":[{\"data\":[[0, 0], [0, 1000], [1920, 1000], [1920, 0]]}]}"}}} 响应参数说明 参数名称 字段类型 描述信息 task Object 作业详情，定义见Task参数结构说明。

请求 请求样例1（摄像头输入+DIS/Webhook输出） POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-queue-status-analysis-edge/tasks{ "name": "queue-status-analysis-edge_task", "description": "queue-status-analysis-edge_task", "input": { "type": "edgecamera", "data": [ { "id": "9f8933c9-448c-48e5-8bc0-631ea83b92eb", "index": 0 } ] }, "output": { "dis": { "stream_name": "dis-queue-status-analysis" }, "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, "render_roi_sw": 1, "queue_status_analysis_sw": 1, "target_roi": "{\"polygons\":[{\"data\":[[0, 0], [0, 1000], [1920, 1000], [1920, 0]]}]}" } }} 请求样例2（edgerestful输入+DIS/Webhook输出） POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-queue-status-analysis-edge/tasks{ "name":"queue-status-analysis-edge_task", "description":"queue-status-analysis-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-queue-status-analysis" }, "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, "render_roi_sw":1, "queue_status_analysis_sw":1, "target_roi":"{\"polygons\":[{\"data\":[[0, 0], [0, 1000], [1920, 1000], [1920, 0]]}]}" } }} 请求样例3（VCN输入+DIS/Webhook输出） POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-queue-status-analysis-edge/tasks{ "name":"queue-status-analysis-edge_task", "description":"queue-status-analysis-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-queue-status-analysis" }, "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, "render_roi_sw":1, "queue_status_analysis_sw":1, "target_roi":"{\"polygons\":[{\"data\":[[0, 0], [0, 1000], [1920, 1000], [1920, 0]]}]}" } }} 参数说明 参数 是否必选 类型 说明 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 服务的算法配置，配置参数见ServiceConfig参数说明。 service_config中common参数说明 字段 是否必选 类型 说明 image_compression_ratio 否 Int 对应控制台的界面参数“图片压缩比”。 图片压缩百分比，取值范围为[20，100]。 默认值：90，表示图片压缩比为90%。 render_result_sw 否 Int 对应控制台的界面参数“目标框渲染开关”。 输出图像是否绘制告警目标边框，取值范围: "0"：表示不绘制。 "1"：表示用红色绘制告警目标边框。 默认值为0。 render_roi_sw 否 Int 对应控制台的界面参数“检测区域渲染开关”。 输出图像是否绘制检测区域，取值范围: "0"：表示不绘制。 "1"：表示用黄色绘制用户设定区域。 默认值为0。 queue_status_analysis_sw 否 Int 对应控制台的界面参数“排队状态分析开关”。 取值范围: "0"：表示不开启。 "1"：表示开启。 默认值为1。 target_roi 否 String 对应控制台的界面参数“检测区域设置”。 表示检测区域，该字段为JSON格式的字符串，API调用时需要加转义符。详细JSON格式参见target_roi（目标区域）。 例如： {"polygons":[{"data":[[84,389],[1840,349],[1824,526],[78,526]]}]} 参数没有携带时，默认区域为整个视频帧中间的1/4。 当target_roi参数未设置时，区域默认位置如图1所示，其中Wframe为帧宽度，Hframe为帧高度。 图1 区域默认位置 默认区域为矩形，假设矩形的四个端点分别为point_1、point_2、point_3、point_4，其位置默认为： poin_1=(¼Wframe， ¼Hframe) poin_2=(¾Wframe， ¼Hframe) poin_3=(¼Wframe， ¾Hframe) poin_4=(¾Wframe， ¾Hframe)

响应 响应样例 { "id":"d86edc86e1c44acbae3901b8473185f7", "name":"abandon-edge_0", "creator":"user_test", "project_id":"1f793beac00d4801874db741cbfe10fa", "description":"abandon-edge", "service_version":"3.0", "edge_pool_id":"a3c7e2aec01d406a8a7f6177199d8a8d", "resource_order_id":"840a5cf90d4a4bbaa71f251dfe8fe64e", "created_at":"2020-09-19T02:54:39Z", "updated_at":"2020-09-19T02:54:39Z", "state":"RUNNING", "input":{ "type":"edgecamera", "data":[ { "id":"6233039b-698f-4347-8ced-ef0d14605c0b", "index":0 } ] }, "output": { "webhook":{ "url":"https://apigw.xx.com/api/mqs/sit", "headers":{ "content-type":"application/json" } } }, "service_config":{ "common":{ "detection_min_size":50, "alert_time_threshold":10, "alert_detection_interval":5, "image_compression_ratio":80, "render_result_sw":1, "target_roi": "{"polygons":[{"data":[[84,389],[1840,349],[1824,526],[78,526]]}]}", "render_roi_sw":1 } }} 响应参数说明 参数名称 字段类型 描述信息 task Object task详情，定义见Task参数结构说明。

响应 响应样例（VIS输入+DIS输出） { "id":"5c127c7844674d2382b7daae07794152", "name":"c-living-detect-cloud-test", "creator":"user_test", "project_id":"1f793beac00d4801874db741cbfe10fa", "description":"c-living-detect task test", "service_version":"3.0", "resource_order_id":"840a5cf90d4a4bbaa71f251dfe8fe64e", "created_at":"2020-09-22T08:08:39Z", "updated_at":"2020-09-22T08:08:39Z", "state":"PENDING", "input":{ "type":"vis", "data":[ { "stream_name":"c-living-detect-cloud-video", "index":0 } ] }, "output":{ "dis":{ "stream_name":"dis-living-detect-cloud" } }, "service_config":{ "common":{ "detection_max_size":50, "detection_min_size":5, "image_compression_ratio":90, "render_result_sw":1, "render_roi_sw":1, "target_roi":"{"polygons":[{"data":[[100,100],[1800,100],[1800,1000],[100,1000]]}]}" } }} 响应参数说明 参数名称 字段类型 描述信息 task Object task详情，定义见 Task参数结构说明。

检测结果 输出JSON数据流到DIS指定的通道，包括告警结构化数据和图片数据。 JSON结果示例： { "stream_id": "vis-campusgo", "event_type":589824, "task_id":"3d7c81cf35784d88a4e26066bcc5debd", "timestamp": 1527603463, "message_id": "0DD1BEA6-634B-11E8-8B0B-407D0FAD9218", "data":{ "event_set":[ { "bounding_box":{ "x":100, "y":200, "w":80, "h":150 } "type_cloth":0, "type_hat":0 }, { "bounding_box":{ "x":200, "y":300, "w":70, "h":150 } "type_cloth":0, "type_hat":1 } ] }, "image_base64": "/3j24AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQE..."}

请求 请求样例（VIS输入+DIS输出） POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-safetysuitedetection-cloud/tasks{ "name": "safetysuitedetection-cloud-task", "input": { "type": "vis", "data": [ { "stream_name": "vis-campusgo", "index": 0 } ] }, "output": { "dis": { "stream_name": "dis-campusgo" } }, "service_version": "3.0", "resource_order_id": "840a5cf90d4a4bbaa71f251dfe8fe64e", "service_config": { "common": { "hat_detection_sw": 0, "cloth_detection_sw": 1, "render_result_sw": 1, "render_roi_sw": 1, "target_roi": "{\"polygons\":[{\"data\":[[84,389],[1840,349],[1824,526],[78,526]]}]}", "image_compression_ratio":90 } }} 参数说明 参数 是否必选 类型 说明 name 是 String 作业名称，只能由中文、字母（a～zA～Z）、数字（0～9）、中划线（-）、下划线（_）组成，长度范围为[1，100]。 description 否 String 作业描述信息，最大长度为500字符长度。 input 是 Object 视频数据输入列表，目前云上工服工帽检测支持以下输入类型： vis：从 视频接入 服务中读取视频数据。 详细参数定义参见task.input（任务输入参数）。 service_version 是 String 功能版本号，版本号为3.0。 resource_order_id 是 String 购买的算法能力包ID，在服务界面购买算法能力包获取。 output 是 Object 结果数据的输出列表，目前支持将结果输出到您指定的通道中，输出类型为“dis”。 详细参数定义参见task.output（任务输出参数）。 service_config 否 Object 服务的算法配置，配置参数见ServiceConfig参数说明。 service_config中common的参数说明 字段 是否必选 类型 说明 hat_detection_sw 否 Int 对应控制台的界面参数“工帽检测开关”。 检测工帽开关： 0：表示不检测。 1：表示检测。 默认值为1。 cloth_detection_sw 否 Int 对应控制台的界面参数“工服检测开关”。 检测工服开关： 0：表示不检测。 1：表示检测。 默认值为1。 render_result_sw 否 Int 对应控制台的界面参数“目标框渲染开关”。 输出图像是否绘制告警目标边框，取值范围: "0"：表示不绘制； "1"：表示用红色绘制告警目标边框。 默认值为0。 render_roi_sw 否 Int 对应控制台的界面参数“检测区域渲染开关”。 输出图像是否绘制检测区域，取值范围: "0"：表示不绘制； "1"：表示用黄色绘制用户设定区域。 默认值为0。 target_roi 否 String 对应控制台的界面参数“检测区域设置”。 表示检测区域，该字段为JSON格式的字符串，API调用时需要加转义符。详细JSON格式参见target_roi（目标区域）。 例如： {"polygons":[{"data":[[84,389],[1840,349],[1824,526],[78,526]]}]} 参数没有携带时，默认区域为整个视频帧。 image_compression_ratio 否 Int 对应控制台的界面参数“图片压缩比”。 图片压缩百分比，取值范围为[20，100]。 默认值：90，表示图片压缩比为90%。

响应消息 删除失败时的响应示例 { "error_code": "IVA.0004", "error_msg": "The request param is invalid. parameter [task_id] does not match ^[0-9a-f]{32}|task\\w{8}$."} 响应参数说明 参数名称 描述信息 error_code 错误码。 error_msg 错误信息。

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

响应 响应样例（VIS输入+DIS输出） { "id":"5c127c7844674d2382b7daae07794152", "name":"event-action-recog-cloud-task", "creator":"user_test", "project_id":"1f793beac00d4801874db741cbfe10fa", "description":"event-action-recog task test", "service_version":"3.0", "resource_order_id":"840a5cf90d4a4bbaa71f251dfe8fe64e", "created_at":"2020-09-22T08:08:39Z", "updated_at":"2020-09-22T08:08:39Z", "state":"PENDING", "input":{ "type":"vis", "data":[ { "stream_name":"pose-action-recog-cloud-video", "index":0 } ] }, "output":{ "dis":{ "stream_name":"dis-pose-action-recog-cloud" } }, "service_config":{ "common":{ "climb_detection_sw":1, "fall_detection_sw":0, "wave_detection_sw":0, "bend_detection_sw":0, "render_result_sw":1, "render_roi_sw":1, "target_roi":"{"polygons":[{"data":[[0,0],[0,1080],[1920,1080],[1920,0]]}]}", "image_compression_ratio":90 } }} 响应参数说明 参数名称 字段类型 描述信息 task Object task详情，定义见Task参数结构说明。

请求 请求样例（VIS输入+DIS输出） POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-trash-abnormal-detect-cloud/tasks{ "name":"c-trash-abnormal-detect-cloud-task", "description":"c-trash-abnormal-detect task test", "input":{ "type":"vis", "data":[ { "stream_name":"c-trash-abnormal-detect-cloud-video", "index":0 } ] }, "output":{ "dis":{ "stream_name":"dis-trash-abnormal-detect-cloud" } }, "service_version":"3.0", "resource_order_id":"840a5cf90d4a4bbaa71f251dfe8fe64e", "service_config":{ "common":{ "alert_time_threshold":30, "render_result_sw":1, "render_roi_sw":1, "target_roi":"{\"polygons\":[{\"data\":[[43,266],[42,645],[472,644],[416,212]]},{\"data\":[[311,182],[282,670],[941,661],[835,170]]}]}", "image_compression_ratio":80 } }} 参数说明 参数 是否必选 类型 说明 name 是 String 作业名称，只能由中文、字母（a～zA～Z）、数字（0～9）、中划线（-）、下划线（_）组成，长度范围为[1，100]。 description 否 String 作业描述信息，最大长度为500字符长度。 input 是 Object 视频数据输入列表，目前云上垃圾桶异常检测支持以下输入类型： vis：从视频接入服务中读取视频数据。 详细参数定义参见task.input（任务输入参数）。 service_version 是 String 功能版本号，版本号为3.0。 resource_order_id 是 String 购买的算法能力包ID，在服务界面购买算法能力包获取。 output 是 Object 结果数据的输出列表，目前支持将结果输出到您指定的DIS通道中，即输出类型为“dis”。 详细参数定义参见task.output（任务输出参数）。 service_config 否 Object 服务的算法配置，配置参数见ServiceConfig参数说明。 service_config中common的参数说明 字段 是否必选 类型 说明 alert_time_threshold 否 Int 对应控制台的界面参数“告警触发时间”。当检测到垃圾桶状态异常达到该时长是触发告警。取值范围[30, 3600], 单位秒。 默认值：30。 target_roi 否 String 对应控制台的界面参数“区域设置”。 垃圾桶检测区域，当在该区域内的垃圾桶被检测到异常状态时，触发告警。 该字段为JSON格式的字符串，API调用时需要加转义符。详细JSON格式参见target_roi（目标区域）。 例如： {"polygons":[{"data":[[43,266],[42,645],[472,644],[416,212]]},{"data":[[311,182],[282,670],[941,661],[835,170]]}]} 参数没有携带时，默认全屏都是检测区域。 render_result_sw 否 Int 对应控制台的界面参数“目标框渲染开关”。 输出图像是否绘制告警目标边框，取值范围: "0"：表示不绘制； "1"：表示用红色绘制告警目标边框。 默认值为0。 render_roi_sw 否 Int 对应控制台的界面参数“检测区域渲染开关”。 输出图像是否绘制检测区域，取值范围: "0"：表示不绘制； "1"：表示用黄色绘制用户设定区域。 默认值为0。 image_compression_ratio 否 Int 对应控制台的界面参数“图片压缩比”。 输出图片压缩百分比，取值范围为[20，100]。 默认值：90，表示图片压缩比为90%。

请求 请求样例（VIS输入+DIS输出） POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-event-action-recog-cloud/tasks{ "name":"event-action-recog-cloud-task", "description":"event-action-recog task test", "input":{ "type":"vis", "data":[ { "stream_name":"event-action-recog-cloud-video", "index":0 } ] }, "output":{ "dis":{ "stream_name":"dis-event-action-recog-cloud" } }, "service_version":"3.0", "resource_order_id":"840a5cf90d4a4bbaa71f251dfe8fe64e", "service_config":{ "common":{ "smoking_detection_sw":1, "phoning_detection_sw":0, "render_result_sw":1, "render_roi_sw":1, "target_roi":"{\"polygons\":[{\"data\":[[84,389],[1840,349],[1824,526],[78,526]]}]}", "image_compression_ratio":90 } }} 参数说明 参数 是否必选 类型 说明 name 是 String 作业名称，只能由中文、字母（a～zA～Z）、数字（0～9）、中划线（-）、下划线（_）组成，长度范围为[1，100]。 description 否 String 作业描述信息，最大长度为500字符长度。 input 是 Object 视频数据输入列表，目前云上个体事件行为检测支持以下输入类型： vis：从视频接入服务中读取视频数据。 详细参数定义参见task.input（任务输入参数）。 service_version 是 String 功能版本号，版本号为3.0。 resource_order_id 是 String 购买的算法能力包ID，在服务界面购买算法能力包获取。 output 是 Object 结果数据的输出列表，目前支持将结果输出到您指定的通道中，输出类型为“dis”。 详细参数定义参见task.output（任务输出参数）。 service_config 否 Object 服务的算法配置，配置参数见ServiceConfig参数说明。 service_config中common参数说明 字段 是否必选 类型 说明 smoking_detection_sw 否 Int 对应控制台的界面参数“吸烟检测开关”。 对输入视频流是否检测吸烟动作，取值范围： "0"：表示不检测吸烟动作； "1"：表示检测吸烟动作。 默认值为1。 phoning_detection_sw 否 Int 对应控制台的界面参数“打手机检测开关”。 对输入视频流是否检测打手机动作，取值范围： "0"：表示不检测打手机动作； "1"：表示检测打手机动作。 默认值为0。 render_result_sw 否 Int 对应控制台的界面参数“目标框渲染开关”。 输出图像是否绘制告警目标边框，取值范围: "0"：表示不绘制； "1"：表示用红色绘制告警目标边框。 默认值为0。 render_roi_sw 否 Int 对应控制台的界面参数“检测区域渲染开关”。 输出图像是否绘制检测区域，取值范围: "0"：表示不绘制； "1"：表示用黄色绘制用户设定区域。 默认值为0。 target_roi 否 String 对应控制台的界面参数“检测区域设置”。 表示检测区域，该字段为JSON格式的字符串，API调用时需要加转义符。详细JSON格式参见target_roi（目标区域）。 例如： {"polygons":[{"data":[[84,389],[1840,349],[1824,526],[78,526]]}]} 参数没有携带时，默认区域为整个视频帧。 image_compression_ratio 否 Int 对应控制台的界面参数“图片压缩比”。 图片压缩百分比，取值范围为[20，100]。 默认值：90，表示图片压缩比为90%。

响应 响应样例（VIS输入+DIS输出） { "id": "3d7c81cf35784d88a4e26066bcc5debd", "name": "smoke-and-fire-cloud-task", "creator": "user_test", "project_id": "1f793beac00d4801874db741cbfe10fa", "description": null, "service_version": "3.0", "resource_order_id":"840a5cf90d4a4bbaa71f251dfe8fe64e", "created_at": "2020-09-22T07:37:03Z", "updated_at": "2020-09-22T07:37:03Z", "state": "RUNNING", "input": { "type": "vis", "data": [ { "stream_name": "vis-campusgo", "index": 0 } ] }, "output": { "dis": { "stream_name": "dis-campusgo" } }, "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 } }} 响应参数说明 参数名称 字段类型 描述信息 task Object task详情，定义见 Task参数结构说明。