创建仿真场景
功能介绍
该接口用于创建基于OpenSCENARIO标准的仿真场景。支持OpenSCENARIO 0.9.1 - 1.1.1 版本的场景。
URI
POST /v2/{project_id}/sim/sm/scenarios
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
url |
是 |
String |
仿真场景的资源地址。 |
id |
是 |
Integer |
仿真场景ID。 |
created_at |
是 |
Double |
创建时间。 最小值:0 |
updated_at |
是 |
Double |
更新时间。 最小值:0 |
labels |
是 |
Array of LabelBriefSrlz objects |
场景所关联的标签。场景标签体系为树状结构,按照OpenLABEL标准进行设计。 |
gen_scenario |
否 |
String |
泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入,并关联到导入的泛化场景。 |
road_scenario |
是 |
String |
路采场景资源地址。通过该字段判断仿真场景是否由路采场景导入,并关联到导入的路采场景。 |
description |
是 |
MutableFileSrlz object |
描述的内容。 |
file |
否 |
file object |
仿真场景文件,场景文件为OpenSCENARIO格式。 |
simulator |
是 |
String |
仿真器,支持VTD和SimPro。 枚举值:
|
version |
是 |
String |
场景对应的OpenSCENARIO版本。 枚举值:
|
map_filename |
否 |
String |
地图文件名称,地图文件为OpenDRIVE格式。 最大长度:255 |
model_filename |
否 |
String |
地图文件所关联的3D模型文件名称,当前支持OSGB格式。 最大长度:255 |
user_id |
否 |
String |
用户id。 最大长度:64 |
user_name |
否 |
String |
用户名。 最大长度:64 |
name |
是 |
String |
场景名称。 最大长度:256 |
priority |
否 |
Integer |
场景仿真优先级。在运行仿真任务时会优先运行高优先级的场景。 枚举值:
|
map |
否 |
String |
场景地图资源地址。 |
model |
否 |
String |
场景3D模型资源地址。 |
source |
否 |
String |
场景来源。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
场景标签名称。 最大长度:64 |
url |
是 |
String |
场景标签资源地址。 |
id |
是 |
Integer |
场景标签ID。 |
family |
否 |
Integer |
场景标签类别。 枚举值:
|
root |
否 |
Long |
场景标签所在标签树的根标签ID。 最小值:-9223372036854775808 最大值:9223372036854775807 |
tag_type |
否 |
String |
场景标签所属标签树名称。 最大长度:64 |
parent_names |
是 |
Array of objects |
父标签名称。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
url |
是 |
String |
文件资源地址。 |
sha256 |
是 |
String |
文件sha256值。 最小长度:64 最大长度:64 |
created_at |
是 |
Double |
创建时间。 最小值:0 |
updated_at |
是 |
Double |
更新时间。 最小值:0 |
post |
是 |
post object |
POST预签链接信息,用于上传文件。 |
put_url |
是 |
String |
PUT预签链接地址,用于上传文件。优先使用POST方法上传。 |
get_url |
是 |
String |
GET地址,用于下载文件。 |
expire |
是 |
Integer |
默认失效时间为600秒。 缺省值:600 |
ready |
是 |
Boolean |
文件状态。完成文件上传状态为true,未完成文件上传状态为false。 |
filename |
是 |
String |
文件名。 最大长度:255 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
url |
否 |
String |
POST预签链接信息,用于上传文件。 |
fields |
否 |
PostResponseField object |
POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
否 |
String |
Post预签链接Key字段,在创建请求时需要添加到请求头。 |
x-amz-algorithm |
否 |
String |
Post预签链接x-amz-algorithm字段,在创建请求时需要添加到请求头。 |
x-amz-credential |
否 |
String |
Post预签链接x-amz-credential字段,在创建请求时需要添加到请求头。 |
x-amz-date |
否 |
String |
Post预签链接x-amz-date字段,在创建请求时需要添加到请求头。 |
policy |
否 |
String |
Post预签链接policy字段,在创建请求时需要添加到请求头。 |
x-amz-signature |
否 |
String |
Post预签链接x-amz-signature字段,在创建请求时需要添加到请求头。 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
url |
String |
仿真场景的资源地址。 |
id |
Integer |
仿真场景ID。 |
created_at |
Double |
创建时间。 最小值:0 |
updated_at |
Double |
更新时间。 最小值:0 |
labels |
Array of LabelBriefSrlz objects |
场景所关联的标签。场景标签体系为树状结构,按照OpenLABEL标准进行设计。 |
gen_scenario |
String |
泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入,并关联到导入的泛化场景。 |
road_scenario |
String |
路采场景资源地址。通过该字段判断仿真场景是否由路采场景导入,并关联到导入的路采场景。 |
description |
MutableFileSrlz object |
描述的内容。 |
file |
file object |
仿真场景文件,场景文件为OpenSCENARIO格式。 |
simulator |
String |
仿真器,支持VTD和SimPro。 枚举值:
|
version |
String |
场景对应的OpenSCENARIO版本。 枚举值:
|
map_filename |
String |
地图文件名称,地图文件为OpenDRIVE格式。 最大长度:255 |
model_filename |
String |
地图文件所关联的3D模型文件名称,当前支持OSGB格式。 最大长度:255 |
user_id |
String |
用户id。 最大长度:64 |
user_name |
String |
用户名。 最大长度:64 |
name |
String |
场景名称。 最大长度:256 |
priority |
Integer |
场景仿真优先级。在运行仿真任务时会优先运行高优先级的场景。 枚举值:
|
map |
String |
场景地图资源地址。 |
model |
String |
场景3D模型资源地址。 |
source |
String |
场景来源。 枚举值:
|
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
场景标签名称。 最大长度:64 |
url |
String |
场景标签资源地址。 |
id |
Integer |
场景标签ID。 |
family |
Integer |
场景标签类别。 枚举值:
|
root |
Long |
场景标签所在标签树的根标签ID。 最小值:-9223372036854775808 最大值:9223372036854775807 |
tag_type |
String |
场景标签所属标签树名称。 最大长度:64 |
parent_names |
Array of objects |
父标签名称。 |
参数 |
参数类型 |
描述 |
---|---|---|
url |
String |
文件资源地址。 |
sha256 |
String |
文件sha256值。 最小长度:64 最大长度:64 |
created_at |
Double |
创建时间。 最小值:0 |
updated_at |
Double |
更新时间。 最小值:0 |
post |
post object |
POST预签链接信息,用于上传文件。 |
put_url |
String |
PUT预签链接地址,用于上传文件。优先使用POST方法上传。 |
get_url |
String |
GET地址,用于下载文件。 |
expire |
Integer |
默认失效时间为600秒。 缺省值:600 |
ready |
Boolean |
文件状态。完成文件上传状态为true,未完成文件上传状态为false。 |
filename |
String |
文件名。 最大长度:255 |
参数 |
参数类型 |
描述 |
---|---|---|
url |
String |
POST预签链接信息,用于上传文件。 |
fields |
PostResponseField object |
POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
Post预签链接Key字段,在创建请求时需要添加到请求头。 |
x-amz-algorithm |
String |
Post预签链接x-amz-algorithm字段,在创建请求时需要添加到请求头。 |
x-amz-credential |
String |
Post预签链接x-amz-credential字段,在创建请求时需要添加到请求头。 |
x-amz-date |
String |
Post预签链接x-amz-date字段,在创建请求时需要添加到请求头。 |
policy |
String |
Post预签链接policy字段,在创建请求时需要添加到请求头。 |
x-amz-signature |
String |
Post预签链接x-amz-signature字段,在创建请求时需要添加到请求头。 |
请求示例
创建仿真场景
POST https://{endpoint}/v2/{project_id}/sim/sm/scenarios/ { "name" : "my-scenario", "simulator" : "my-simulator", "priority" : 40, "description" : { "content" : "scenario description" }, "version" : "v1.1.1", "map" : "/v2/my_projectid/sim/sm/maps/2631662/", "map_filename" : "ALKS_Road_straight.xodr", "source" : "UPLOAD" }
响应示例
状态码: 201
请求成功
-
{ "url" : "/v2/my_project_id/sim/sm/scenarios/361/", "id" : 361, "created_at" : 1.699954029362022E9, "updated_at" : 1.699954029362044E9, "labels" : [ ], "gen_scenario" : null, "road_scenario" : null, "description" : { "content" : "scenario description" }, "file" : null, "simulator" : "my-simulator", "version" : "v1.1.1", "map_filename" : "ALKS_Road_straight.xodr", "model_filename" : null, "user_id" : "userId", "user_name" : "userName", "name" : "my-scenario", "priority" : 40, "map" : "/v2/my_project_id/sim/sm/maps/2631662/", "model" : null, "source" : "UPLOAD" }
状态码
状态码 |
描述 |
---|---|
201 |
请求成功 |
错误码
请参见错误码。