更新时间:2023-12-29 GMT+08:00
分享

查询长期交通事件列表

功能介绍

查询长期交通事件列表

调试

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

URI

GET /v1/{project_id}/traffic-events

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。

取值范围:仅支持数字,a到f的小写字母组合,长度32。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数说明:查询事件列表的页码。

最小值:0

最大值:100

缺省值:0

limit

Integer

参数说明:查询时每页显示的记录数。

最小值:1

最大值:20

缺省值:10

area_code

Integer

参数说明:区域码,参考区域码查询

最小值:0

最大值:999999

status

String

参数说明:事件状态。

取值范围

  • Invalid:为过期事件,事件结束时间(end_time)在当前时间之前。

  • Active:为活动事件,事件开始时间(start_time)在当前时间之前,并且事件结束时间(end_time)在当前时间之后。

  • Future:为未来事件,事件开始时间(start_time)在当前时间之前。

缺省值:all

event_type

Integer

参数说明:事件编码。参考“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。

最小值:0

最大值:1000

event_source_type

Array

参数说明:事件来源类型列表,支持事件来源。

取值范围

  • unknown:未知数据

  • police:警方数据

  • government:政府数据

  • meteorological:气象数据

  • internet:互联网数据

  • detection:检测器检测到的数据

  • v2xServer:平台上报数据

  • rsu:RSU上报数据

  • obu:车载终端上报数据

数组长度:0 - 9

event_class

String

参数说明:事件分类,获取方法请参见“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。当填写event_type时,event_class为必选。

event_id

String

参数说明:事件ID,创建事件后获得。方法参见 “新增交通事件”接口。

最小值:0

最大值:255

from_time

String

参数说明:查询事件开始时间段的起始时间。

格式:yyyy-MM-dd'T'HH:mm:ss'Z'。

例如 2020-09-01T01:37:01Z。

to_time

String

参数说明:查询事件开始时间段的结束时间。

格式:yyyy-MM-dd'T'HH:mm:ss'Z'。

例如 2020-09-01T01:37:01Z。

sort_key

String

参数说明:按照哪一个字段排序,默认按事件开始时间。

最小长度:0

最大长度:255

枚举值:

  • start_time

  • end_time

  • created_time

  • last_modified_time

sort_dir

String

参数说明:升序或降序,升序为ASC, 降序为DESC,默认降序。

枚举值:

  • ASC

  • DESC

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

String

参数说明:实例ID。DRIS物理实例的唯一标识,获取方法请参见“API参考 > 附录 > 获取Instance-Id”。

取值范围:仅支持数字,小写字母和横杠(-)的组合,长度36。

X-Auth-Token

String

参数说明:用户Token,Token认证鉴权时必选。通过调用IAM服务 “获取IAM用户Token”接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见“API参考 > API > 应用侧API参考 > 如何调用API > 认证鉴权 > Token认证”。

最小长度:1

最大长度:20000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Long

参数说明:返回条目总数量。

最小值:0

最大值:2147483647

events

Array of TrafficEventDTO objects

参数说明:事件列表。

数组长度:0 - 2147483647

表5 TrafficEventDTO

参数

参数类型

描述

status

String

参数说明:事件状态。

取值范围

  • Invalid:为过期事件,事件结束时间(end_time)在当前时间之前。

  • Active:为活动事件,事件开始时间(start_time)在当前时间之前,并且事件结束时间(end_time)在当前时间之后。

  • Future:为未来事件,事件开始时间(start_time)在当前时间之前。

event_id

String

参数说明:事件ID,创建事件后获得。方法参见 “新增交通事件”接口。

最小长度:0

最大长度:255

event_source_type

String

参数说明:事件来源类型列表,支持事件来源。

取值范围

  • unknown:未知数据

  • police:警方数据

  • government:政府数据

  • meteorological:气象数据

  • internet:互联网数据

  • detection:检测器检测到的数据

  • v2xServer:平台上报数据

  • rsu:RSU上报数据

  • obu:车载终端上报数据

event_source_id

String

参数说明:事件来源的ID,由用户自定义。

取值范围:长度不超过255。只允许字母、数字、下划线(_)、连接符(-)的组合。

event_class

String

参数说明:事件分类,获取方法请参见“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。当填写event_type时,event_class为必选。

event_type

Integer

参数说明:事件编码。参考“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。

最小值:0

最大值:1000

area_code

Integer

参数说明:区域码,参考区域码查询

最小值:0

最大值:999999

event_level

Integer

参数说明:事件优先级,0-7越大优先级越高。

最小值:0

最大值:7

event_params

Map<String,String>

参数说明:事件附加信息。

事件类型为如下数据时生效:

  • 道路最高限:必选,设置最高限速(整数值)km/h

  • 道路最低限速:必选,设置最低限速(整数值)km/h

  • 建议速度:必选,建议速度(整数值)km/h

  • 急弯路:可选,建议最高限速(整数值)km/h

  • 雨:可选,请输入1~4:1-细雨,2-小雨,3-中雨,4-大雨

  • 雪:可选,请输入1~4:1-小雪,2-中雪,3-大雪,4-暴雪

  • 风:可选,设置风速值(整数值)km/h

  • 雾:可选,请输入1或2:1-薄雾,2-浓雾

  • 路面湿滑:可选,设置湿滑系数(0~1)

  • 路面结冰:可选,请设置冰层厚度(整数值)mm

建议填写方式为:user_defined_param1: "xx"

event_position

EventLocation object

参数说明:事件位置。

event_description

String

参数说明:事件的文本描述信息,可自行扩展需传递的信息。长度不超过255。支持中文、英文字母、数字及中英文常用符号:。?!,、;:“ ”()《》【】_/~?!#%^&*=+-等

reference_paths

Array of EventReferencePath objects

参数说明:事件生效的关联路径,至少需写入起始和终止位置的两个坐标点。

数组长度:0 - 10

event_position_name

String

参数说明:事件所在位置。

最小长度:0

最大长度:255

start_time

String

参数说明:开始时间。

格式:yyyy-MM-dd''T''HH:mm:ss''Z''。

例如 2020-09-01T01:37:01Z。

end_time

String

参数说明:结束时间。

格式:yyyy-MM-dd''T''HH:mm:ss''Z''。

例如 2020-09-01T01:37:01Z。

note

String

参数说明:备注。长度不超过255。支持中文、英文字母、数字及中英文常用符号:。?!,、;:“ ”()《》【】_/~?!#%^&*=+-等

event_confidence

Integer

参数说明:事件可信度。

最小值:0

最大值:1000

created_time

String

'参数说明:创建时间。

格式:yyyy-MM-dd''T''HH:mm:ss''Z''。

例如 2020-09-01T01:37:01Z。

last_modified_time

String

参数说明:最后修改的时间。

格式:yyyy-MM-dd''T''HH:mm:ss''Z''。

例如 2020-09-01T01:37:01Z。

coordinate

String

参数说明:请求体消息中所携带的经纬度数据的坐标系。

取值范围

  • GCJ02:02坐标。

  • WGS84:84坐标。

表6 EventLocation

参数

参数类型

描述

lat

Number

参数说明:定义纬度数值,北纬为正,南纬为负,单位°,精度小数点后7位。

最小值:-90

最大值:90

lon

Number

参数说明:定义经度数值。东经为正,西经为负,单位°,精度小数点后7位。

最小值:-180

最大值:180

表7 EventReferencePath

参数

参数类型

描述

active_path

Array of EventLocation objects

参数说明:激活路径。

数组长度:0 - 10

path_radius

Integer

参数说明:事件的影响区域半径,可选,单位为分米。用半径表示影响区域边界离中心线的垂直距离,反映该区域的宽度以覆盖实际路段。

最小值:0

最大值:2147483647

缺省值:1000

请求示例

GET https://{endpoint}/v1/{project_id}/traffic-events?limit={limit}&status={status}&area_code={area_code}&offset={offset}&event_type={event_type}&event_source_type={event_source_type}&event_class={event_class}&event_id={event_id}&from_time={from_time}&to_time={to_time}&sort_key={sort_key}&sort_dir={sort_dir}
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********

响应示例

状态码: 200

OK

{
  "count" : 1,
  "events" : [ {
    "status" : "Active",
    "event_id" : "bdd0da88-a22c-4259-8679-947b772512a3",
    "event_source_type" : "v2xServer",
    "event_source_id" : 301,
    "event_class" : "AbnormalVehicle",
    "event_type" : 903,
    "area_code" : 440330,
    "event_level" : 0,
    "event_params" : {
      "additionalProp1" : "50"
    },
    "event_position" : {
      "lat" : 22.123456,
      "lon" : 114.123456
    },
    "event_description" : "qCSYD6jdXBLlm65GB9TguIV1ra80Mc0k",
    "reference_paths" : [ {
      "active_path" : [ {
        "lat" : 22.123456,
        "lon" : 114.123456
      } ],
      "path_radius" : 1000
    } ],
    "event_position_name" : "F4(V2X 办公区域) ",
    "start_time" : "2021-12-23T08:32:51.618Z",
    "end_time" : "2021-12-23T08:32:51.618Z",
    "note" : "note",
    "event_confidence" : 100,
    "coordinate" : "WGS84",
    "created_time" : "2021-12-23T08:32:51.618Z",
    "last_modified_time" : "2021-12-23T08:32:51.618Z"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

429

Too Many Requests

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品