文档首页/ 路网数字化服务 DRIS/ API参考/ API/ 应用侧API参考/ 即时交通事件管理/ 创建即时交通事件

更新时间：2024-10-24 GMT+08:00

查看PDF

创建即时交通事件

功能介绍

创建即时交通事件，平台分发即时交通事件给目标设备的接口。事件一旦创建便会立即下发且只会下发一次。

调试

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

URI

POST /v1/{project_id}/immediate-event

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数说明：项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。取值范围：仅支持数字，a到f的小写字母组合，长度32。

请求参数

表2 请求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认证”。

表3 请求Body参数
参数	是否必选	参数类型	描述
send_config	是	SendConfig object	参数说明：分发通道及目标设备。
immediate_event	是	ImmediateEventDTO object	参数说明：即时事件的内容。

表4 SendConfig
参数	是否必选	参数类型	描述
channel	是	Channel object	参数说明：分发通道，至少指定一个通道。
target_list	否	TargetList object	参数说明：目标设备类型对应id的列表。

表5 Channel
参数	是否必选	参数类型	描述
by_lte_pc5	否	Boolean	参数说明：LTE-PC5传输通道。若通过LTE-PC5传输通道下发事件，该字段为true。
by_lte_uu	否	Boolean	参数说明：LTE-Uu的传输通道。若通过LTE-Uu的传输通道下发事件，该字段为true。

表6 TargetList
参数	是否必选	参数类型	描述
target_rsu_ids	否	Array of strings	参数说明：通过LTE-PC5传输通道（by_lte_pc5参数值为true）下发的rsu esn列表。如果rsu esn列表为空，则匹配事件范围内的在线rsu进行下发。
target_obu_ids	否	Array of strings	参数说明：通过LTE-Uu的传输通道（by_lte_uu参数值为true）下发的车辆ID（在平台注册车辆时填写）列表。注意车辆ID列表不能为空。

表7 ImmediateEventDTO
参数	是否必选	参数类型	描述
time_stamp	是	String	参数说明：事件发生时间，毫秒级。格式：yyyy-MM-dd''T''HH:mm:ss.SSS''Z'' 例如 2015-12-12T12:12:12.356Z。
event_class	是	String	参数说明：事件分类，获取方法请参见“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。当填写event_type时，event_class为必选。
event_type	是	Integer	参数说明：事件编码。参考“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。
event_source	是	String	参数说明：事件来源类型列表,支持事件来源。取值范围： unknown：未知数据 police：警方数据 government：政府数据 meteorological：气象数据 internet：互联网数据 detection：检测器检测到的数据 v2xServer：平台上报数据 rsu：RSU上报数据 obu：车载终端上报数据
event_source_id	否	String	参数说明：事件来源的ID，由用户自定义。取值范围：长度不超过255。只允许字母、数字、下划线（_）、连接符（-）的组合。
event_confidence	否	Integer	参数说明：道路交通事件的信息来源提供的事件置信度水平，帮助接收端判断是否相信该事件信息，可选。
event_position	是	Position3D object	位置信息。
event_radius	否	Integer	参数说明：事件的发生区域半径，单位为分米。
event_description	否	String	参数说明：事件的文本描述信息，可自行扩展需传递的信息。长度不超过255。支持中文、英文字母、数字及中英文常用符号：。？！，、；：“ ”（）《》【】_/~?!#%^&*=+-等
event_priority	否	Integer	参数说明：事件优先级，0-7，数字越大，级别越高。
reference_paths	否	Array of EventReferencePath objects	参数说明：事件生效的关联路径。
coordinate	否	String	参数说明：请求体消息中所携带的经纬度数据的坐标系。取值范围： GCJ02：02坐标。 WGS84：84坐标。

表8 Position3D
参数	是否必选	参数类型	描述
lat	是	Number	参数说明：定义纬度数值，北纬为正，南纬为负，单位°，精度小数点后7位。
lon	是	Number	参数说明：定义经度数值。东经为正，西经为负，单位°，精度小数点后7位。
ele	否	Number	参数说明：定义海拔高程，可选，单位为分米。

表9 EventReferencePath
参数	是否必选	参数类型	描述
active_path	是	Array of Position3D objects	参数说明：通过点集合定义一个有向的作用范围。
path_radius	否	Integer	参数说明：事件的影响区域半径，可选，单位为分米。用半径表示影响区域边界离中心线的垂直距离，反映该区域的宽度以覆盖实际路段。

响应参数

状态码： 201

**表10** 响应Body参数
参数	参数类型	描述
event_id	String	参数说明：即时事件ID。
send_config	SendConfigResponse object	参数说明：分发通道选择及目标推送设备的配置。
immediate_event	ImmediateEventResponseDTO object	参数说明：即时事件的内容。

**表11** SendConfigResponse
参数	参数类型	描述
channel	Channel object	参数说明：分发通道，至少指定一个通道。
target_list	TargetList object	参数说明：目标设备类型对应id的列表。

**表12** Channel
参数	参数类型	描述
by_lte_pc5	Boolean	参数说明：LTE-PC5传输通道。若通过LTE-PC5传输通道下发事件，该字段为true。
by_lte_uu	Boolean	参数说明：LTE-Uu的传输通道。若通过LTE-Uu的传输通道下发事件，该字段为true。

**表13** TargetList
参数	参数类型	描述
target_rsu_ids	Array of strings	参数说明：通过LTE-PC5传输通道（by_lte_pc5参数值为true）下发的rsu esn列表。如果rsu esn列表为空，则匹配事件范围内的在线rsu进行下发。
target_obu_ids	Array of strings	参数说明：通过LTE-Uu的传输通道（by_lte_uu参数值为true）下发的车辆ID（在平台注册车辆时填写）列表。注意车辆ID列表不能为空。

**表14** ImmediateEventResponseDTO
参数	参数类型	描述
time_stamp	String	参数说明：事件发生时间，毫秒级。格式：yyyy-MM-dd''T''HH:mm:ss.SSS''Z'' 例如 2015-12-12T12:12:12.356Z。
event_class	String	参数说明：事件分类，获取方法请参见“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。当填写event_type时，event_class为必选。
event_type	Integer	参数说明：事件编码。参考“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。
event_source	String	参数说明：事件来源类型列表,支持事件来源。取值范围： unknown：未知数据 police：警方数据 government：政府数据 meteorological：气象数据 internet：互联网数据 detection：检测器检测到的数据 v2xServer：平台上报数据 rsu：RSU上报数据 obu：车载终端上报数据
event_source_id	String	参数说明：事件来源的ID，由用户自定义。取值范围：长度不超过255。只允许字母、数字、下划线（_）、连接符（-）的组合。
event_confidence	Integer	参数说明：道路交通事件的信息来源提供的事件置信度水平，帮助接收端判断是否相信该事件信息，可选。
event_position	Position3D object	位置信息。
event_radius	Integer	参数说明：事件的发生区域半径，单位为分米。
event_description	String	参数说明：事件的文本描述信息，可自行扩展需传递的信息。长度不超过255。支持中文、英文字母、数字及中英文常用符号：。？！，、；：“ ”（）《》【】_/~?!#%^&*=+-等
event_priority	Integer	参数说明：事件优先级，0-7，数字越大，级别越高。
reference_paths	Array of EventReferencePath objects	参数说明：事件生效的关联路径。
coordinate	String	参数说明：请求体消息中所携带的经纬度数据的坐标系。取值范围： GCJ02：02坐标。 WGS84：84坐标。

**表15** Position3D
参数	参数类型	描述
lat	Number	参数说明：定义纬度数值，北纬为正，南纬为负，单位°，精度小数点后7位。
lon	Number	参数说明：定义经度数值。东经为正，西经为负，单位°，精度小数点后7位。
ele	Number	参数说明：定义海拔高程，可选，单位为分米。

**表16** EventReferencePath
参数	参数类型	描述
active_path	Array of Position3D objects	参数说明：通过点集合定义一个有向的作用范围。
path_radius	Integer	参数说明：事件的影响区域半径，可选，单位为分米。用半径表示影响区域边界离中心线的垂直距离，反映该区域的宽度以覆盖实际路段。

请求示例

POST https://{endpoint}/v1/{project_id}/immediate-event
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********

{
  "send_config" : {
    "channel" : {
      "by_lte_pc5" : false,
      "by_lte_uu" : false
    },
    "target_list" : {
      "target_rsu_ids" : [ "rsu0123456789" ],
      "target_obu_ids" : [ "obu0123456789" ]
    }
  },
  "immediate_event" : {
    "time_stamp" : "2015-12-12T12:12:12.356Z",
    "event_class" : "traffic sign",
    "event_type" : 39,
    "event_source" : "internet",
    "event_source_id" : 123456789,
    "event_confidence" : 100,
    "event_position" : {
      "lat" : 40.1234567,
      "lon" : 116.1234567,
      "ele" : 1000
    },
    "event_radius" : 1000,
    "event_description" : 123456789,
    "event_priority" : 3,
    "coordinate" : "WGS84",
    "reference_paths" : [ {
      "active_path" : [ {
        "lat" : 40.1234567,
        "lon" : 116.1234567,
        "ele" : 1000
      }, {
        "lat" : 50.1234567,
        "lon" : 136.1234567,
        "ele" : 1000
      } ],
      "path_radius" : 1000
    } ]
  }
}

响应示例

状态码： 201

Created

{
  "send_config" : {
    "channel" : {
      "by_lte_pc5" : false,
      "by_lte_uu" : false
    },
    "target_list" : {
      "target_rsu_ids" : [ "rsu0123456789" ],
      "target_obu_ids" : [ "obu0123456789" ]
    }
  },
  "immediate_event" : {
    "time_stamp" : "2015-12-12T12:12:12.356Z",
    "event_class" : "traffic sign",
    "event_type" : 39,
    "event_source" : "internet",
    "event_source_id" : "0123456789",
    "event_confidence" : 100,
    "event_position" : {
      "lat" : 40.1234567,
      "lon" : 116.1234567,
      "ele" : 1000
    },
    "event_radius" : 1000,
    "event_description" : "0123456789",
    "event_priority" : 3,
    "reference_paths" : [ {
      "active_path" : [ {
        "lat" : 40.1234567,
        "lon" : 116.1234567,
        "ele" : 1000
      }, {
        "lat" : 50.1234567,
        "lon" : 136.1234567,
        "ele" : 1000
      } ],
      "path_radius" : 1000
    } ],
    "coordinate" : "WGS84"
  }
}

状态码

状态码	描述
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
409	Conflict
429	Too Many Requests
500	Internal Server Error

错误码

请参见错误码。

父主题： 即时交通事件管理

上一篇：即时交通事件管理

下一篇：数据转发配置管理

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建即时交通事件

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线