摄像头巡检（2102023）

接口信息

API Path
/aipaas/cv/v2/image/2102023

请求协议
HTTPS

请求方法
POST

请求头部 ：

头部标签	必填	说明	类型	数据字典	限制	头部内容	示例
Content-Type	是	application/json	[string]			application/json	application/json
X-APP-ID	是	买家中心-已购能力-【X-APP-ID】	[string]
Device-Uuid	是	设备管理-设备uuid	[string]
Authorization	是	新鉴权调用时必传	[string]

请求参数 Json
Object

参数名	说明	必填	类型	数据字典	限制	示例
code	请求状态码，固定1019	是	[int]
data	算法参数	是	[object]
data>>task_id	算法任务id	是	[string]			0d04322bee08401a9c15a5ef8643e64f
data>>camera_id	设备编码	是	[string]			A15414521025
data>>algo_tasks	算法参数数组	是	[array]
data>>algo_tasks>>algo_config	单个参数信息	是	[object]
data>>algo_tasks>>algo_config>>version	参数版本号	否	[string]			1.0.0
data>>algo_tasks>>algo_config>>algo_roi	roi区域配置【如果算法不支持roi，忽略此参数解析】	是	[object]
data>>algo_tasks>>algo_config>>algo_roi>>roi_type	roi坐标类型，1-绝对坐标，2-相对坐标【is_full_region为true时为非必填】	是	[int]	1:绝对坐标,2:相对坐标		1
data>>algo_tasks>>algo_config>>algo_roi>>roi_list	设定区域列表【is_full_region为false时为必填】	否	[array]
data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>name	区域id，需单一请求内唯一	是	[string]			61b3a095eb0bc49
data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>point_list	区域坐标点集【由算法内部判断，画线至少需要2个点，画多边形区域至少需要3个点】	是	[array]
data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>point_list>>x	X轴坐标	是	[float]			0.0
data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>point_list>>y	Y轴坐标	是	[float]			1.0
data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>extra_params	区域扩展参数	否	[array]
data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>extra_params>>key	参数名	是	[string]			type
data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>extra_params>>value	参数值	是	[string]			1
data>>algo_tasks>>algo_config>>algo_roi>>is_full_region	是否全景图，true-是，false-否	是	[boolean]	true:是,false:否		true
data>>algo_tasks>>algo_config>>algo_roi>>region_mode	推荐默认值为1 1：检测框中心点在区域内即代表检测目标在区域内 2：检测框脚点在区域内即代表检测目标在区域内 3：检测框中心点与脚点同时在区域内即代表检测目标在区域内 4：检测框中心点或脚点在区域内即代表检测目标在区域内	是	[int]	1:检测框中心点在区域内即代表检测目标在区域内,2:检测框脚点在区域内即代表检测目标在区域内,3:检测框中心点与脚点同时在区域内即代表检测目标在区域内,4:检测框中心点或脚点在区域内即代表检测目标在区域内		1
data>>image	图片Base64(jpeg格式base64编码)【和image二选一，优先使用image字段】	否	[string]			iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC
data>>image_url	图片地址【和image二选一，优先使用image字段】	否	[string]			http://10.127.156.152:8081/bucket/f7884c2f-0efc-42ae-0372-e30eddddc53b.jpg

响应内容 ：

返回结果

> 成功 (200)
> Json
> Object

参数名	说明	必填	类型	数据字典	限制	示例
code	算法类型，固定1020	是	[int]			1020
data	算法调用结果	是	[object]
data>>error_code	错误码，值为APP_ERR_OK则为成功	是	[string]			APP_ERR_OK
data>>error_message	错误描述	是	[string]			正常状态
data>>camera_id	创建任务时传入的设备编码	是	[string]			A15414521025
data>>task_id	创建任务时传入的算法任务id	是	[string]			0d04322bee08401a9c15a5ef8643e64f
data>>frame_id	视频帧id	是	[string]			0d04322bee08401a9c15a5ef8sldufj8
data>>frame_width	图片宽度	是	[string]			1920
data>>frame_height	图片高度	是	[string]			1080
data>>send_pts_ms	算法结果告警时时间戳。距离1970-01-01毫秒数	是	[string]			1694078498549
data>>pull_pts_ms	算法拉流时间戳。距离1970-01-01毫秒数	是	[string]			1694078498549
data>>display_image	告警场景图Base64【jpeg格式base64编码】	是	[string]			iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC
data>>algo_outputs	算法处理结果数组	是	[array]
data>>algo_outputs>>roi_message	设定区域信息	否	[object]
data>>algo_outputs>>roi_message>>name	创建任务时传入的区域id	是	[string]			61b3a095eb0bc49
data>>algo_outputs>>roi_message>>point_list	创建任务时传入的区域坐标点集	是	[array]
data>>algo_outputs>>roi_message>>point_list>>x	创建任务时传入的X轴坐标	是	[float]			0.0
data>>algo_outputs>>roi_message>>point_list>>y	创建任务时传入的Y轴坐标	是	[float]			1.0
data>>algo_outputs>>roi_message>>extra_params	区域额外参数	否	[array]
data>>algo_outputs>>roi_message>>extra_params>>key	创建任务时传入的参数名【是否告警参数名固定为alarm】	是	[string]			alarm
data>>algo_outputs>>roi_message>>extra_params>>value	创建任务时传入的参数值【是否告警固定为1或者0】	是	[string]			1
data>>algo_outputs>>objectinfo	检测到的目标对象数组	是	[array]
data>>algo_outputs>>objectinfo>>class_name	目标类别名称， blur (模糊) , colorshift (偏色) , noise (雪花+干扰) , normal (正常) , overexpose (过曝) , occlusion (遮挡) , abnormal_angle (角度异常), 除3-normal (正常)外，其他均为告警	是	[string]			目标类别名称
data>>algo_outputs>>objectinfo>>class_id	目标类别id，0-blur (模糊) , 1-colorshift (偏色) , 2-noise (雪花+干扰) , 3-normal (正常) , 4-overexpose (过曝) , 5-occlusion (遮挡) , 6-abnormal_angle (角度异常),	是	[int]			1
data>>algo_outputs>>objectinfo>>rect	对象位置坐标	是	[object]
data>>algo_outputs>>objectinfo>>rect>>x0	左上X轴坐标	是	[float]			0.0
data>>algo_outputs>>objectinfo>>rect>>y0	左上Y轴坐标	是	[float]			0.0
data>>algo_outputs>>objectinfo>>rect>>x1	右下X轴坐标	是	[float]			100.0
data>>algo_outputs>>objectinfo>>rect>>y1	右下Y轴坐标	是	[float]			100.0
data>>algo_outputs>>objectinfo>>confidence	目标置信度(0~1)	是	[float]			0.99
data>>algo_outputs>>objectinfo>>track_id	目标追踪ID，此业务未使用	是	[string]			0d04322bee0
data>>algo_outputs>>objectinfo>>score	模型得分，(0~1)，得分无效为-1	是	[float]			0.99
data>>algo_outputs>>objectinfo>>extra_message	目标额外信息，见详细说明	否	[array]
data>>algo_outputs>>objectinfo>>extra_message>>key	参数名	是	[string]			type
data>>algo_outputs>>objectinfo>>extra_message>>value	参数值	是	[string]			1
data>>algo_outputs>>objectinfo>>image_message	目标图片信息	否	[array]
data>>algo_outputs>>objectinfo>>image_message>>key	图片名称	是	[string]			xxx.jpg
data>>algo_outputs>>objectinfo>>image_message>>value	图片Base64【jpeg格式base64编码】	是	[string]			iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC
data>>extra_message	算法处理结果额外信息，透传给上层应用	否	[array]
data>>extra_message>>key	参数名【如果为多算法镜像，固定返回算法标识的key必须为algo_type】	是	[string]			algo_type
data>>extra_message>>value	参数值【如果为多算法镜像，值为具体算法标识】	是	[string]			7009

成功示例[Mock API] ：

{
    "code": 1020,
    "data": {
        "error_code": "APP_ERR_OK",
        "error_message": "",
        "camera_id": "1",
        "task_id": "task_1",
        "algo_type": "7050",
        "frame_id": "2533",
        "frame_width": "2880",
        "frame_height": "1620",
        "send_pts_ms": "0",
        "pull_pts_ms": "0",
        "display_image": "",
        "algo_outputs": [{
            "roi_message": {
                "name": "position_0",
                "point_list": [{
                    "x": 0,
                    "y": 0
                }, {
                    "x": 2880,
                    "y": 0
                }, {
                    "x": 2880,
                    "y": 1620
                }, {
                    "x": 0,
                    "y": 1620
                }],
                "extra_params": [{
                    "key": "person_num",
                    "value": "4"
                }]
            },
            "objectinfo": [{
                "class_name": "HEAD",
                "class_id": 0,
                "rect": {
                    "x0": 2061,
                    "y0": 498,
                    "x1": 2319,
                    "y1": 840
                },
                "confidence": 0.909386337,
                "track_id": "",
                "score": -1,
                "extra_message": [{
                    "key": "bind_idx",
                    "value": "1"
                }],
                "image_message": []
            }, {
                "class_name": "PERSON",
                "class_id": 1,
                "rect": {
                    "x0": 1937,
                    "y0": 482,
                    "x1": 2323,
                    "y1": 1620
                },
                "confidence": 0.889317155,
                "track_id": "",
                "score": -1,
                "extra_message": [{
                    "key": "bind_idx",
                    "value": "0"
                }],
                "image_message": []
            }, {
                "class_name": "HEAD",
                "class_id": 0,
                "rect": {
                    "x0": 1651,
                    "y0": 83,
                    "x1": 1844,
                    "y1": 296
                },
                "confidence": 0.832615197,
                "track_id": "",
                "score": -1,
                "extra_message": [{
                    "key": "bind_idx",
                    "value": "3"
                }],
                "image_message": []
            }, {
                "class_name": "PERSON",
                "class_id": 1,
                "rect": {
                    "x0": 1592,
                    "y0": 78,
                    "x1": 2031,
                    "y1": 1532
                },
                "confidence": 0.905128837,
                "track_id": "",
                "score": -1,
                "extra_message": [{
                    "key": "bind_idx",
                    "value": "2"
                }],
                "image_message": []
            }, {
                "class_name": "HEAD",
                "class_id": 0,
                "rect": {
                    "x0": 773,
                    "y0": 108,
                    "x1": 940,
                    "y1": 271
                },
                "confidence": 0.806108713,
                "track_id": "",
                "score": -1,
                "extra_message": [{
                    "key": "bind_idx",
                    "value": "5"
                }],
                "image_message": []
            }, {
                "class_name": "PERSON",
                "class_id": 1,
                "rect": {
                    "x0": 702,
                    "y0": 102,
                    "x1": 1221,
                    "y1": 1405
                },
                "confidence": 0.862656891,
                "track_id": "",
                "score": -1,
                "extra_message": [{
                    "key": "bind_idx",
                    "value": "4"
                }],
                "image_message": []
            }, {
                "class_name": "PERSON",
                "class_id": 1,
                "rect": {
                    "x0": 702,
                    "y0": 102,
                    "x1": 1221,
                    "y1": 1405
                },
                "confidence": 0.862656891,
                "track_id": "",
                "score": -1,
                "extra_message": [],
                "image_message": []
            }]
        }],
        "extra_message": []
    }
}

详细说明 ：

1.算法版本迭代适用版本

版本	算法总集版本号	备注
摄像头巡检（2102023）		初始版本

2. 服务鉴权

1.服务接口调用时需要严格遵循服务鉴权规则，新老调用鉴权方式亦存在差异。
新调用鉴权规则请参见：开发指南 - 内网签名认证方式。
2.服务调用头信息
调用时header头信息X-APP-ID，Device-Uuid，Authorization必传

3.参数说明

区域条件：
只支持全图

3.1请求参数示例：

{
	"code": 1019,
	"data": {
		"camera_id": "1",
		"task_id": "task_1",
		"algo_tasks": [{
			"algo_config": {
				"version": "algo_version",
				"algo_roi": {
					"is_full_region": false,
					"region_mode": 1,
					"roi_type": 1,
					"roi_list": [{
						"name": "position_1",
						"point_list": [{
							"x": 0,
							"y": 0
						}, {
							"x": 2880,
							"y": 0
						}, {
							"x": 2880,
							"y": 1310
						}, {
							"x": 0,
							"y": 1310
						}]
					}, {
						"name": "position_2",
						"point_list": [{
							"x": 0,
							"y": 1310
						}, {
							"x": 0,
							"y": 1620
						}, {
							"x": 2880,
							"y": 1620
						}, {
							"x": 2880,
							"y": 1310
						}]
					}]
				},
				"extra_params": []
			}
		}],
		"image": "'"
	}
}

4. 调用示例

4.1Java示例

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;

public class HttpUtils {
    public static void sendPostRequest() {
        HttpURLConnection connection = null;
        try {
            String code = "code";
            String url = "http://url:端口/aipass/aipassweb-api/openapi/openApi/v2/ai/2102023";
            String appId = "appid";        
            String deviceUuid = "deviceUuid";
            URL urlObj = new URL(url);
            connection = ((HttpURLConnection) (urlObj.openConnection()));
            connection.setRequestMethod("POST");
            connection.setRequestProperty("Content-Type", "application/json");
        
            connection.setRequestProperty("X-APP-ID", appId);   
            connection.setRequestProperty("Device-Uuid", deviceUuid);     
            connection.setRequestProperty("Authorization", "yourAuthorization");

            connection.setDoOutput(true);
            ObjectMapper objectMapper = new ObjectMapper();
            ObjectNode requestBody = objectMapper.createObjectNode();
            requestBody.put("code", 0);
            requestBody.put("llm_check", 0);
            ObjectNode dataNode = requestBody.putObject("data");
            dataNode.put("task_id", "0d04322bee08401a9c15a5ef8643e64f");
            dataNode.put("camera_id", "A15414521025");
            ArrayNode algoTasksArray = dataNode.putArray("algo_tasks");
            ObjectNode algoTaskNode = algoTasksArray.addObject();
            ObjectNode algoConfigNode = algoTaskNode.putObject("algo_config");
            algoConfigNode.put("version", "1.0.0");
            ObjectNode algoRoiNode = algoConfigNode.putObject("algo_roi");
            algoRoiNode.put("roi_type", 1);
            ArrayNode roiListArray = algoRoiNode.putArray("roi_list");
            ObjectNode roiListNode = roiListArray.addObject();
            roiListNode.put("name", "61b3a095eb0bc49");
            ArrayNode pointListArray = roiListNode.putArray("point_list");
            ObjectNode pointNode = pointListArray.addObject();
            pointNode.put("x", 0.0);
            pointNode.put("y", 1.0);
            ArrayNode extraParamsArray = roiListNode.putArray("extra_params");
            ObjectNode extraParamNode = extraParamsArray.addObject();
            extraParamNode.put("key", "type");
            extraParamNode.put("value", "1");
            algoRoiNode.put("is_full_region", true);
            algoRoiNode.put("region_mode", 1);
            ArrayNode extraParamsAlgoArray = algoConfigNode.putArray("extra_params");
            ObjectNode extraAlgoParamNode = extraParamsAlgoArray.addObject();
            extraAlgoParamNode.put("key", "");
            extraAlgoParamNode.put("value", "");
            dataNode.put(
                    "image",
"iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC");
            dataNode.put(
                    "image_url",
                    "http://10.127.156.152:8081/bucket/f7884c2f-0efc-42ae-0372-e30eddddc53b.jpg");
            try (OutputStream os = connection.getOutputStream()) {
                byte[] input = requestBody.toString().getBytes("utf-8");
                os.write(input, 0, input.length);
            }
            int responseCode = connection.getResponseCode();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                try (BufferedReader br =
                             new BufferedReader(new InputStreamReader(connection.getInputStream(), "utf-8"))) {
                    StringBuilder response = new StringBuilder();
                    String responseLine;
                    while ((responseLine = br.readLine()) != null) {
                        response.append(responseLine.trim());
                    }
                    String responseString = response.toString();
                    JsonNode jsonResponse = objectMapper.readTree(responseString);
                    JsonNode data = jsonResponse.get("data");
                }
            } else {
                System.out.println("POST request not worked");
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
    }
}

4.2 Python示例

import json
import requests

def send_post_request():
    """
    发送POST请求到指定API端点
    """
    try:
        # 配置参数
        url = "http://url:端口/aipass/aipassweb-api/openapi/openApi/v2/ai/2102023"
        app_id = "appid"
        device_uuid = "deviceUuid"
        authorization = "yourAuthorization"

        # 构建请求头
        headers = {
            "Content-Type": "application/json",
            "X-APP-ID": app_id,
            "Device-Uuid": device_uuid,
            "Authorization": authorization
        }

        # 构建请求体 - 与Java代码完全对应
        request_body = {
            "code": 0,
            "llm_check": 0,
            "data": {
                "task_id": "0d04322bee08401a9c15a5ef8643e64f",
                "camera_id": "A15414521025",
                "algo_tasks": [
                    {
                        "algo_config": {
                            "version": "1.0.0",
                            "algo_roi": {
                                "roi_type": 1,
                                "roi_list": [
                                    {
                                        "name": "61b3a095eb0bc49",
                                        "point_list": [
                                            {
                                                "x": 0.0,
                                                "y": 1.0
                                            }
                                        ],
                                        "extra_params": [
                                            {
                                                "key": "type",
                                                "value": "1"
                                            }
                                        ]
                                    }
                                ],
                                "is_full_region": True,
                                "region_mode": 1
                            },
                            "extra_params": [
                                {
                                    "key": "",
                                    "value": ""
                                }
                            ]
                        }
                    }
                ],
                "image": "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC",
                "image_url": "http://10.127.156.152:8081/bucket/f7884c2f-0efc-42ae-0372-e30eddddc53b.jpg"
            }
        }

        # 发送POST请求
        response = requests.post(
            url=url,
            headers=headers,
            json=request_body,
            timeout=30
        )

        # 处理响应
        if response.status_code == 200:
            response_data = response.json()
            data = response_data.get("data")
            print("POST请求成功")
            return data
        else:
            print(f"POST请求失败，状态码: {response.status_code}")
            print(f"响应内容: {response.text}")
            return None

    except requests.exceptions.RequestException as e:
        print(f"请求异常: {e}")
        return None
    except json.JSONDecodeError as e:
        print(f"JSON解析错误: {e}")
        return None
    except Exception as e:
        print(f"其他错误: {e}")
        return None

# 使用示例
if __name__ == "__main__":
    result = send_post_request()
    if result is not None:
        print("请求处理成功")
        print(f"返回数据: {result}")
    else:
        print("请求处理失败")