查询场景列表-QueryScenarioList
功能介绍
本接口用于查询基于OpenSCENARIO标准的仿真场景列表。支持OpenSCENARIO 0.9.1 - 1.1.1 版本的场景。
URI
GET https://{hostURL}/v2/{project_id}/sim/sm/scenarios
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
exclude_group |
否 |
Integer |
查询时不包括的场景组。 |
|
file |
否 |
String |
场景文件。 |
|
gen_scenario |
否 |
String |
泛化场景的资源地址。 |
|
group |
否 |
Array of integers |
场景组ID。 |
|
id |
否 |
Integer |
场景ID。 |
|
label |
否 |
Number |
标签ID。 |
|
map |
否 |
Integer |
地图ID。 |
|
name |
否 |
String |
场景名称。 |
|
ordering |
否 |
String |
用于排序的字段，查询结果会基于该字段排序。 |
|
offset |
否 |
Integer |
分页查询的偏移。 |
|
limit |
否 |
Integer |
分页查询时查询结果数量。 |
|
search |
否 |
String |
查询条件。 |
|
simulator |
否 |
String |
仿真器，如B。 |
|
source |
否 |
String |
场景来源，可选项包括: [GENERALIZATION, ROAD, UPLOAD, BUILT_IN]，分别表示泛化场景，路采场景，用户自建场景和内置场景。 |
|
status |
否 |
Integer |
场景状态信息：
|
|
user_name |
否 |
String |
用户名 |
|
version |
否 |
String |
场景对应的OpenSCENARIO版本 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
列表中实例的数量。 |
|
next |
String |
下一个分页的查询地址。 |
|
previous |
String |
上一个分页的查询地址。 |
|
results |
Array of ScenarioListSrlz objects |
仿真场景列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
url |
String |
仿真场景的资源地址。 |
|
id |
Integer |
仿真场景ID。 |
|
created_at |
TimeStamp |
创建时间。 |
|
updated_at |
TimeStamp |
更新时间。 |
|
labels |
Array of LabelBriefSrlz objects |
场景标签。场景标签体系为树状结构，按照OpenLABEL标准进行设计。 |
|
gen_scenario |
String |
泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入，并关联到导入的泛化场景。 |
|
road_scenario |
String |
路采场景资源地址。通过该字段判断仿真场景是否由路采场景导入，并关联到导入的路采场景。 |
|
simulator |
String |
仿真器，如B。 |
|
version |
String |
场景对应的OpenSCENARIO版本。 |
|
filename |
String |
场景文件名，场景文件为OpenSCENARIO格式。 |
|
map_filename |
String |
地图文件名称，地图文件为OpenDRIVE格式。 |
|
model_filename |
String |
地图文件所关联的3D模型文件名称，当前支持OSGB格式。 |
|
user_id |
String |
用户ID。 |
|
user_name |
String |
用户名。 |
|
name |
String |
场景名称。 |
|
priority |
Integer |
场景优先级取值，取值越大，优先级越高。可从如下范围中选择：
|
|
status |
Integer |
场景状态信息：
|
|
map |
String |
场景地图资源地址。 |
|
model |
String |
场景3D模型资源地址。 |
|
source |
String |
请求示例
无
响应示例
状态码：200
请求成功
{
"count" : 347,
"next" : "http://{endpoint}/v2/{project_id}/sim/sm/scenarios/?limit=1&offset=1",
"previous" : null,
"results" : [ {
"url" : "/v2/{project_id}/sim/sm/scenarios/1/",
"id" : 1,
"created_at" : 1.70071476428303E9,
"updated_at" : 1.700714764892153E9,
"labels" : [ ],
"gen_scenario" : null,
"road_scenario" : null,
"simulator" : "B",
"version" : "v1.0.0",
"filename" : "cutin.xosc",
"map_filename" : "city.xodr",
"model_filename" : null,
"user_id" : "my-userid",
"user_name" : "my-username",
"name" : "cutin",
"priority" : 40,
"status" : 0,
"map" : "/v2/{project_id}/sim/sm/maps/1/",
"model" : null
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
错误码
请参见错误码。
