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

创建边缘垃圾桶满溢检测作业

功能介绍

该API用于分析用户边缘节点上的RTSP视频流,当用户输入视频中有垃圾桶满溢,则上报告警。

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

调试

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

URI

  • URI格式
    POST /v2/{project_id}/services/c-trash-overflow-edge/tasks
  • 参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

    服务所在区域对应的项目ID,获取方法请参见获取项目ID

请求

  • 请求样例1(VCN输入+WEBHOOK输出)
    POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-trash-overflow-edge/tasks
    {
        "name": "trash-overflow-task",
        "description": "trash-overflow task test",
        "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": {
            "webhook":{
                "url":"https://apigw.xx.com/api/mqs/sit",
                "headers":{
                    "content-type":"application/json"
                }
            }
        },
        "service_version": "3.0",
        "resource_order_id": "840a5cf90d4a4bbaa71f251dfe8fe64e",
        "edge_pool_id": "8dcf5ec7bc4d4a26aa1d3e1bb5ed2b5a",
        "service_config": {
            "common": {
    	        "trash_overflow_interval": 300,
    	        "render_result_sw": 1,
    	        "render_roi_sw": 1,
    	        "target_roi":"{\"polygons\":[{\"data\":[[80,570],[337,565],[339,889],[80,891]]}]}",
    	        "image_compression_ratio": 90
              }
            }
    }
  • 请求样例2(摄像头输入+DIS输出)
    POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-trash-overflow-edge/tasks
    {
        "name": "trash-overflow-edge-task",
        "description": "trash-overflow-edge task test",
        "input": {
            "type": "edgecamera",
            "data": [
                {
                    "id": "aec5857c-222f-4aa9-be39-23654e118886",
                    "index": 0
                }
            ]
        },
        "output": {
            "dis": {
                "stream_name": "dis-trash-overflow-edge"
            }
        },  
        "service_version": "3.0",
        "resource_order_id": "840a5cf90d4a4bbaa71f251dfe8fe64e",
        "edge_pool_id": "8dcf5ec7bc4d4a26aa1d3e1bb5ed2b5a",
        "service_config": {
            "common": {
    	        "trash_overflow_interval": 300,
    	        "render_result_sw": 1,
    	        "render_roi_sw": 1,
    	        "target_roi":"{\"polygons\":[{\"data\":[[80,570],[337,565],[339,889],[80,891]]}]}",
    	        "image_compression_ratio": 90
              }
         }
    }
  • 请求样例3(edgerestful输入+DIS输出)
    POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-trash-overflow-edge/tasks
    {
        "name": "trash-overflow-edge-task",
        "description": "trash-overflow-edge-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-trash-overflow-edge"
            }
        },
        "service_version": "3.0",
        "resource_order_id": "840a5cf90d4a4bbaa71f251dfe8fe64e",
        "edge_pool_id": "8dcf5ec7bc4d4a26aa1d3e1bb5ed2b5a",
        "service_config": {
            "common": {
    	        "trash_overflow_interval": 300,
    	        "render_result_sw": 1,
    	        "render_roi_sw": 1,
    	        "target_roi":"{\"polygons\":[{\"data\":[[80,570],[337,565],[339,889],[80,891]]}]}",
    	        "image_compression_ratio": 90
              }
           }
    }
  • 请求样例4(VCN输入+DIS输出)
    POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-trash-overflow-edge/tasks
    {
        "name": "trash-overflow-task",
        "description": "trash-overflow task test",
        "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-trash-overflow-edge"
            }
        },
        "service_version": "3.0",
        "resource_order_id": "840a5cf90d4a4bbaa71f251dfe8fe64e",
        "edge_pool_id": "8dcf5ec7bc4d4a26aa1d3e1bb5ed2b5a",
        "service_config": {
            "common": {
    	        "trash_overflow_interval": 300,
    	        "render_result_sw": 1,
    	        "render_roi_sw": 1,
    	        "target_roi":"{\"polygons\":[{\"data\":[[80,570],[337,565],[339,889],[80,891]]}]}",
    	        "image_compression_ratio": 90
              }
            }
    }
  • 参数说明

    参数

    是否必选

    类型

    说明

    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参数结构说明

    字段

    是否必选

    类型

    说明

    trash_overflow_interval

    Int

    对应控制台的界面参数“检测周期”

    垃圾桶满溢检测周期,单位为秒。取值范围为[300, 3600],默认值为300。当时间到达检测周期整数倍时,触发算法检测设定区域中的垃圾桶是否满溢。

    render_result_sw

    Int

    对应控制台的界面参数“目标框渲染开关”

    输出图像是否绘制告警目标边框,默认值为0,取值范围:

    • 0:表示不绘制。
    • 1:表示用红色绘制告警目标边框。

    render_roi_sw

    Int

    对应控制台的界面参数“检测区域渲染开关”

    输出图像是否绘制检测区域,默认值为0,取值范围:

    • 0:表示不绘制。
    • 1:表示用黄色绘制用户设定区域。

    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%。

响应

  • 响应样例
    [
      { 
        "id": "9e64eeff407647f28201419e5ce3eacd"
      }
    ]
  • 返回作业ID列表

    参数

    类型

    说明

    id

    String

    作业ID。

检测结果

  • 输出JSON数据流到指定的DIS通道,包括结构化数据。
  • 结果示例:
    {
        "event_type":983040,
        "task_id":"9e64eeff407647f28201419e5ce3eacd",
        "stream_id":"126345674979",
        "timestamp":1535546604,
        "message_id":"0DD1BEA6-634B-11E8-8B0B-407D0FAD9218",
        "image_base64":"/9j/4AAQSkZJRgABAJDA...",
        "data":{
            "event_set":[
                {
                    "bounding_box":{
                        "x":100,
                        "y":200,
                        "w":200,
                        "h":100
                    }
                },
                {
                    "bounding_box":{
                        "x":100,
                        "y":200,
                        "w":200,
                        "h":100
                    }
                }
            ]
        }
    }
  • JSON格式说明

    字段

    类型

    说明

    event_type

    Uint64

    事件类型,垃圾桶满溢检测的事件类型为983040。

    对应16进制为 0x 0000 0000 000F 0000。

    task_id

    String

    作业ID。

    stream_id

    String

    摄像头编号。

    timestamp

    Uint64

    事件触发时对应的时间戳。

    message_id

    String

    告警ID,生成的唯一告警事件UUID。

    image_base64

    String

    当前触发告警时,对应视频帧的图片Base64编码结果。

    data

    Object

    业务输出内容。

  • data参数说明

    字段

    类型

    说明

    event_set

    List<Object>

    输出事件列表。

  • event_set参数说明

    字段

    类型

    说明

    bounding_box

    Object

    告警输出的垃圾桶对象矩形框。

  • 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

    服务不可用。

相关文档