修改长期交通事件
功能介绍
修改长期交通事件
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v1/{project_id}/traffic-events/{event_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数说明:项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。 取值范围:仅支持数字,a到f的小写字母组合,长度32。 |
event_id |
是 |
String |
参数说明:事件ID,创建事件后获得。方法参见 “新增交通事件”接口。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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认证”。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
event_source_type |
否 |
String |
参数说明:事件来源类型列表,支持事件来源。 取值范围:
|
event_source_id |
否 |
String |
参数说明:事件来源的ID,由用户自定义。 取值范围:长度不超过255。只允许字母、数字、下划线(_)、连接符(-)的组合。 |
event_class |
否 |
String |
参数说明:事件类型,参照附录《国标交通事件及标志列表》文件。当填写event_type时,event_class为必选。 |
event_type |
否 |
Integer |
参数说明:事件编码。参考“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。 |
area_code |
否 |
Integer |
参数说明:区域码,参考区域码查询。 |
event_level |
否 |
Integer |
参数说明:事件优先级,0-7越大优先级越高。 |
event_params |
否 |
Map<String,String> |
参数说明:事件附加信息。 事件类型为如下数据时生效:
建议填写方式为:user_defined_param1: "xx" |
event_position |
否 |
EventLocation object |
参数说明:事件位置。 |
event_description |
否 |
String |
参数说明:事件的文本描述信息,可自行扩展需传递的信息。长度不超过255。支持中文、英文字母、数字及中英文常用符号:。?!,、;:“ ”()《》【】_/~?!#%^&*=+-等 |
reference_paths |
否 |
Array of EventReferencePath objects |
参数说明:事件生效的关联路径,至少需写入起始和终止位置的两个坐标点。 |
event_position_name |
否 |
String |
参数说明:事件所在位置。 |
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 |
参数说明:事件可信度。 |
coordinate |
否 |
String |
参数说明:请求体消息中所携带的经纬度数据的坐标系。 取值范围:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
lat |
否 |
Number |
参数说明:定义纬度数值,北纬为正,南纬为负,单位°,精度小数点后7位。 |
lon |
否 |
Number |
参数说明:定义经度数值。东经为正,西经为负,单位°,精度小数点后7位。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
active_path |
否 |
Array of EventLocation objects |
参数说明:激活路径。 |
path_radius |
否 |
Integer |
参数说明:事件的影响区域半径,可选,单位为分米。用半径表示影响区域边界离中心线的垂直距离,反映该区域的宽度以覆盖实际路段。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数说明:事件状态。 取值范围:
|
event_id |
String |
参数说明:事件ID,创建事件后获得。方法参见 “新增交通事件”接口。 |
event_source_type |
String |
参数说明:事件来源类型列表,支持事件来源。 取值范围:
|
event_source_id |
String |
参数说明:事件来源的ID,由用户自定义。 取值范围:长度不超过255。只允许字母、数字、下划线(_)、连接符(-)的组合。 |
event_class |
String |
参数说明:事件分类,获取方法请参见“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。当填写event_type时,event_class为必选。 |
event_type |
Integer |
参数说明:事件编码。参考“API参考 > 附录 > 参数说明列表 > 国标交通标志编码/国标交通事件编码”。 |
area_code |
Integer |
参数说明:区域码,参考区域码查询。 |
event_level |
Integer |
参数说明:事件优先级,0-7越大优先级越高。 |
event_params |
Map<String,String> |
参数说明:事件附加信息。 事件类型为如下数据时生效:
建议填写方式为:user_defined_param1: "xx" |
event_position |
EventLocation object |
参数说明:事件位置。 |
event_description |
String |
参数说明:事件的文本描述信息,可自行扩展需传递的信息。长度不超过255。支持中文、英文字母、数字及中英文常用符号:。?!,、;:“ ”()《》【】_/~?!#%^&*=+-等 |
reference_paths |
Array of EventReferencePath objects |
参数说明:事件生效的关联路径,至少需写入起始和终止位置的两个坐标点。 |
event_position_name |
String |
参数说明:事件所在位置。 |
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 |
参数说明:事件可信度。 |
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 |
参数说明:请求体消息中所携带的经纬度数据的坐标系。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
lat |
Number |
参数说明:定义纬度数值,北纬为正,南纬为负,单位°,精度小数点后7位。 |
lon |
Number |
参数说明:定义经度数值。东经为正,西经为负,单位°,精度小数点后7位。 |
参数 |
参数类型 |
描述 |
---|---|---|
active_path |
Array of EventLocation objects |
参数说明:激活路径。 |
path_radius |
Integer |
参数说明:事件的影响区域半径,可选,单位为分米。用半径表示影响区域边界离中心线的垂直距离,反映该区域的宽度以覆盖实际路段。 |
请求示例
PUT https://{endpoints}/v1/{project_id}/traffic-events/{event_id} Content-Type:application/json X-Auth-Token:******** Instance-Id:******** { "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 }, { "lat" : 23.123456, "lon" : 115.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", "coordinate" : "WGS84" }
响应示例
状态码: 200
OK
{ "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 }, { "lat" : 23.123456, "lon" : 115.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", "coordinate" : "WGS84" }
状态码
状态码 |
描述 |
---|---|
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 |
错误码
请参见错误码。