云服务器内容精选

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 callback_url String 支持http/https协议,最大长度为256常规字符 create_time String 创建时间 subscription_type String 订阅类型字段 枚举值: DEVICE_ALARM 智能告警消息(含第三方告警),该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息,该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据,该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据,该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据,该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据,该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据,该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据,该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据,该消息的数据推送结构体微卡口数据推送结构体
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证token,从获取用户认证token接口获取 表3 请求Body参数 参数 是否必选 参数类型 描述 callback_url 是 String 要添加的URL,支持http和https协议,长度在256常规字符以内,不支持中文,长度范围[1,256] subscription_type 是 String 订阅类型字段 枚举值: DEVICE_ALARM 智能告警消息(含第三方告警),该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息,该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据,该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据,该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据,该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据,该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据,该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据,该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据,该消息的数据推送结构体微卡口数据推送结构体 auth_key 否 string 鉴权密钥:给客户推送消息时,客户认证时使用,长度范围[6,18],该字段为非必填字段,但建议客户填写,有助于提高可靠性。 认证方式如下: 当配置了auth_key后,回调方会根据 (回调地址+"|"+时间戳+"|"+auth_key)用sha256算法做数字摘要。 在回调时,通过HEAD参数 "X-Ivm-Signature" 传递摘要,"X-Ivm-Timestamp"传递时间戳。设置方通过计算sha256(回调地址+"|"+时间戳+"|"+auth_key)进行认证,可参考告警推送消息体结构
  • 功能介绍 配置用户 消息通知 URL(增加或者更新用户消息通知URL)。 配置回调 URL 时将通过 HTTP/HTTPS 请求的方式发送一条测试请求给用户服务器,用户服务器需要处理行业视频管理服务的回调请求,并尽快进行应答。 注意事项: 回调的方向是行业视频管理服务向用户服务器发起 HTTP/HTTPS POST 请求。HTTP是非加密传输,存在安全风险。为了获得更高的安全性,建议您使用 HTTPS 通道发送请求; 行业视频管理服务回调用户服务器的超时时间为 5 秒,且没有重试。如果回调超时,则配置失败。为确保回调成功率,用户服务器应当尽可能加快回调处理速度,例如先发送回调应答,然后再处理具体业务逻辑; 确保回调 URL 的 IP 和端口公网可达,以及防火墙策略不限制外网访问,接口应支持application/json格式的数据 回调请求成功后,确保应答报文中的 HTTP 返回码为 200。 配置回调 URL 时,云服务端会访问该地址是否可用。访问请求体格式为: { "message_id": 1614936351275468803, // int64 或 long 整型 "test": true // boolean 类型 } 注意,在配置好回调 URL,还需要给设备开通接入调阅服务和行业数据流服务后,才能接收到告警数据。 云服务会对连续出现6次及以上异常状态的回调URL进行熔断处理,触发熔断后,10分钟内将不会向该回调URL推送消息。异常状态包括:超过5秒未响应、HTTP返回码非200等。触发熔断时间内,若用户服务器恢复好,可自行通过调用 配置用户消息通知URL接口 来进行解除。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 topic String Topic名称。 partition Integer 分区。 message_offset Integer 消息偏移量。 consumer_key String 应用Key。在该消息头中添加一个consumer_key的消息头。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型 描述 topic 是 String Topic名称。 partition 是 Integer 分区。 message_offset 是 Number 消息偏移量。 consumer_key 否 String 应用Key。在该消息头中添加一个consumer_key的消息头。
  • 响应示例 状态码: 200 OK { "topic" : "topic-test", "partition" : 0, "message_offset" : 4, "consumer_key" : "keyA" } 状态码: 400 Bad Request { "error_code" : 400, "error_msg" : "Bad Request" } 状态码: 403 Forbidden { "error_code" : 403, "error_msg" : "Forbidden" }
  • 请求示例 重发偏移量为4的消息,并为该消息添加指定消息头 POST https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messages/action?action_id=resend { "topic" : "topic-test", "partition" : 0, "message_offset" : 4, "consumer_key" : "keyA" }
  • 请求示例 查询消息偏移量。 GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messages?asc=false&end_time=1608609032042&limit=10&offset=0&start_time=1608608432042&topic=topic-test-mqs 查询消息内容。 GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messagesdownload=false&message_offset=0&partition=0&topic=topic-test-mqs
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 messages Array of messages objects 消息列表。 total Number 消息总数。 size Number 返回总条数。 表5 messages 参数 参数类型 描述 topic String Topic名称。 partition Integer 消息所在的分区。 key String 消息Key。 value String 消息内容。 size Integer 消息大小。 timestamp Integer Topic名称。 huge_message Boolean 大数据标识。 message_offset Integer 消息偏移量。 message_id String 消息ID。 app_id String 集成应用key。 tag String 消息标签。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。
  • 响应示例 状态码: 200 OK { "messages" : [ { "topic" : "topic-test", "partition" : 0, "value" : "hello world", "size" : 21, "timestamp" : 1607598463502, "huge_message" : false, "message_offset" : 4, "message_id" : "", "app_id" : "", "tag" : "" } ], "total" : 1, "size" : 1 } 状态码: 400 Bad Request { "error_code" : 400, "error_msg" : "Bad Request" } 状态码: 403 Forbidden { "error_code" : 403, "error_msg" : "Forbidden" }
  • 响应示例 状态码: 200 OK { "count" : 1, "events" : [ { "event_id" : 11111, "event_source_type" : "RSU", "event_source_id" : 2, "esn" : "2102312ETX10K7000037", "area_code" : 568, "event_class" : "AbnormalTraffic", "event_type" : 100, "cross_id" : 1111, "event_description" : "交通事故", "event_level" : 1, "event_params" : { "speed" : "60" }, "event_position" : { "lat" : 40.1234567, "lon" : 116.1234567, "ele" : 1000 }, "event_position_name" : "深圳深南大道", "reference_paths" : [ { "active_path" : [ { "lat" : 40.1234567, "lon" : 116.1234567, "ele" : 1000 } ], "path_radius" : 100 } ], "note" : "交通事件信息", "event_status" : "Invalid", "event_confidence" : 1, "event_ex_info" : { "participants" : [ { "ptc_type" : "unknown", "plate_no" : "粤B12345", "speed" : 3000, "vehicle_class" : 54, "gat_vehicle_class" : "k33", "track_id" : 123456789, "lane_no" : 1, "target_rects" : [ { "camera_code" : "abcd", "camera_ip" : "127.0.0.1", "target_pos" : [ { "left_top_x" : 10, "left_top_y" : 10, "right_bottom_x" : 5, "right_bottom_y" : 5 } ], "time_stamp_diff" : 1664507548437 } ], "start_time" : 1664507548437 } ], "congestion_info" : { "level" : 0, "length" : 200, "start_point" : { "lat" : 40.1234567, "lon" : 116.1234567, "ele" : 1000 }, "end_point" : { "lat" : 40.1234567, "lon" : 116.1234567, "ele" : 1000 }, "speed" : 10, "start_time" : 1664507548437, "congestion_lanes_info" : [ { "laneid" : 1, "level" : 0, "length" : 200, "speed" : 10, "start_time" : 1664507548437, "start_point" : { "lat" : 40.1234567, "lon" : 116.1234567, "ele" : 1000 }, "end_point" : { "lat" : 40.1234567, "lon" : 116.1234567, "ele" : 1000 } } ] }, "data_source" : { "radar" : [ 0 ], "camera" : [ 1 ] }, "camera_list" : [ { "id" : 0, "ip" : "127.0.0.1" } ] }, "rsu_id" : [ "b58efc27-a6e5-4bca-9d12-c76ecfe3f102" ], "start_time" : "2019-08-28T16:32:24Z", "end_time" : "2019-08-28T16:32:24Z" } ] }
  • 请求示例 GET https://{endpoint}/v1/{project_id}/history-traffic-events?limit={limit}&offset={offset}&from_date={from_date}&to_date={to_date}&event_class={event_class}&event_type={event_type}&event_source={event_source}&event_id={event_id} Content-Type:application/json X-Auth-Token:******** Instance-Id:********
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证token,从获取用户认证token接口获取 表3 请求Body参数 参数 是否必选 参数类型 描述 callback_url 是 String 要添加的URL,支持http和https协议,长度在256常规字符以内,不支持中文,长度范围[1,256] subscription_type 是 String 订阅类型字段 枚举值: DEVICE_ALARM 智能告警消息(含第三方告警),该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息,该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据,该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据,该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据,该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据,该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据,该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据,该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据,该消息的数据推送结构体微卡口数据推送结构体 auth_key 否 string 鉴权密钥:给客户推送消息时,客户认证时使用,长度范围[6,18],该字段为非必填字段,但建议客户填写,有助于提高可靠性。 认证方式如下: 当配置了auth_key后,回调方会根据 (回调地址+"|"+时间戳+"|"+auth_key)用sha256算法做数字摘要。 在回调时,通过HEAD参数 "X-Ivm-Signature" 传递摘要,"X-Ivm-Timestamp"传递时间戳。设置方通过计算sha256(回调地址+"|"+时间戳+"|"+auth_key)进行认证,可参考告警推送消息体结构
  • 功能介绍 配置用户消息通知URL(增加或者更新用户消息通知URL)。 配置回调 URL 时将通过 HTTP/HTTPS 请求的方式发送一条测试请求给用户服务器,用户服务器需要处理行业视频管理服务的回调请求,并尽快进行应答。 注意事项: 回调的方向是行业视频管理服务向用户服务器发起 HTTP/HTTPS POST 请求,为了获得更高的安全性,推荐您使用 HTTPS 通道发送请求; 行业视频管理服务回调用户服务器的超时时间为 1 秒,且没有重试。如果回调超时,则配置失败。为确保回调成功率,用户服务器应当尽可能加快回调处理速度,例如先发送回调应答,然后再处理具体业务逻辑; 确保回调 URL 的 IP 和端口公网可达,以及防火墙策略不限制外网访问,接口应支持application/json格式的数据 回调请求成功后,确保应答报文中的 HTTP 返回码为 200。 配置回调 URL 时,云服务端会访问该地址是否可用。访问请求体格式为: { "message_id": 1614936351275468803, // int64 或 long 整型 "test": true // boolean 类型 } 注意,在配置好回调 URL,还需要给设备开通接入调阅服务和行业数据流服务后,才能接收到告警数据。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 callback_url String 支持http/https协议,最大长度为256常规字符 create_time String 创建时间 subscription_type String 订阅类型字段 枚举值: DEVICE_ALARM 智能告警消息(含第三方告警),该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息,该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据,该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据,该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据,该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据,该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据,该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据,该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据,该消息的数据推送结构体微卡口数据推送结构体