创建仿真场景-CreateSimulationScenario
创建仿真场景
功能介绍
该接口用于创建基于OpenSCENARIO标准的仿真场景。支持OpenSCENARIO 0.9.1 - 1.1.1 版本的场景。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:simScenario:create
Write
-
-
-
-
URI
POST https://{hostURL}/v2/{project_id}/sim/sm/scenarios
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| gen_scenario | 否 | String | 参数解释: 泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入,并关联到导入的泛化场景。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| description | 是 | MutableFileSrlz object | 参数解释: 描述的内容。 约束限制: 不涉及 |
| file | 否 | file object | 参数解释: 仿真场景文件,场景文件为OpenSCENARIO格式。 约束限制: 不涉及 |
| simulator | 是 | String | 参数解释: 仿真器名称。 约束限制: 不涉及。 |
| version | 是 | String | 参数解释: 场景对应的OpenSCENARIO版本。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及 |
| map_filename | 否 | String | 参数解释: 地图文件名称。 约束限制: 地图文件为OpenDRIVE格式。 取值范围: 不涉及。 默认取值: 不涉及 |
| model_filename | 否 | String | 参数解释: 地图文件所关联的3D模型文件名称。 约束限制: 支持OSGB格式。 取值范围: 不涉及。 默认取值: 不涉及 |
| replay_filename | 否 | String | 参数解释: 数据回灌文件名称。 约束限制: 当前支持pblog格式。 取值范围: 不涉及。 默认取值: 不涉及 |
| user_id | 否 | String | 参数解释: 创建者的用户ID。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| user_name | 否 | String | 参数解释: 创建者的用户名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| name | 是 | String | 参数解释: 场景名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| priority | 否 | Integer | 参数解释: 场景优先级取值,取值越大,优先级越高。 约束限制: 不涉及 |
| map | 否 | String | 参数解释: 场景地图资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| model | 否 | String | 参数解释: 场景3D模型资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| replay | 否 | String | 参数解释: 数据回灌资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| source | 否 | String | 参数解释: 场景来源。 约束限制: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| sha256 | 是 | String | 参数解释: 文件SHA256值。 约束限制: 必须是有效的SHA256字符串,可以使用本地哈希工具计算文件的SHA256值。 取值范围: 不涉及。 默认取值: 不涉及 |
| post | 是 | PostResponse object | 参数解释: POST预签链接信息,用于上传文件。 约束限制: 不涉及 |
| filename | 是 | String | 参数解释: 场景文件名。 约束限制: 场景文件为OpenSCENARIO格式。 取值范围: 长度范围[0-255]。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| url | 否 | String | 参数解释: 下一页结果集资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| fields | 否 | PostResponseField object | 参数解释: 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 | 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| updated_at | Double | 参数解释: 更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| labels | Array of LabelBriefSrlz objects | 参数解释: 场景标签。 约束限制: 场景标签体系为树状结构,按照OpenLABEL标准进行设计。 |
| gen_scenario | String | 参数解释: 泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入,并关联到导入的泛化场景。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| road_scenario | String | 参数解释: 路采场景资源地址。通过该字段判断仿真场景是否由路采场景导入,并关联到导入的路采场景。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| description | MutableFileSrlz object | 参数解释: 描述的内容。 约束限制: 不涉及 |
| file | file object | 参数解释: 仿真场景文件,场景文件为OpenSCENARIO格式。 约束限制: 不涉及 |
| simulator | String | 参数解释: 仿真器名称。 约束限制: 不涉及。 |
| version | String | 参数解释: 场景对应的OpenSCENARIO版本。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及 |
| map_filename | String | 参数解释: 地图文件名称。 约束限制: 地图文件为OpenDRIVE格式。 取值范围: 不涉及。 默认取值: 不涉及 |
| model_filename | String | 参数解释: 地图文件所关联的3D模型文件名称。 约束限制: 支持OSGB格式。 取值范围: 不涉及。 默认取值: 不涉及 |
| replay_filename | String | 参数解释: 数据回灌文件名称。 约束限制: 当前支持pblog格式。 取值范围: 不涉及。 默认取值: 不涉及 |
| user_id | String | 参数解释: 创建者的用户ID。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| user_name | String | 参数解释: 创建者的用户名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| name | String | 参数解释: 场景名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| priority | Integer | 参数解释: 场景优先级取值,取值越大,优先级越高。 约束限制: 不涉及 |
| map | String | 参数解释: 场景地图资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| model | String | 参数解释: 场景3D模型资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| replay | String | 参数解释: 数据回灌资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| source | String | 参数解释: 场景来源。 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 场景标签名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| url | String | 参数解释: 场景标签资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| id | Integer | 参数解释: 场景标签ID。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| family | Integer | 参数解释: 标签所属类型信息。 约束限制: 不涉及。 取值范围: 0 - Customized 1 - Odd China 2 - Open Odd 3 - Odd Nhtsa 4 - Open Label 默认取值: 不涉及 |
| root | Long | 参数解释: 场景标签所在标签树的根标签ID。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| tag_type | String | 参数解释: 场景标签所属标签树名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| parent_names | Array of strings | 参数解释: 父标签名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| url | String | 参数解释: 文件资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| sha256 | String | 参数解释: 文件SHA256值。 约束限制: 必须是有效的SHA256字符串,可以使用本地哈希工具计算文件的SHA256值。 取值范围: 不涉及。 默认取值: 不涉及 |
| created_at | Double | 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| updated_at | Double | 参数解释: 更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| post | PostResponse object | 参数解释: POST预签链接信息,用于上传文件。 约束限制: 不涉及 |
| put_url | String | 参数解释: PUT预签链接地址,用于上传文件。优先使用POST方法上传。 约束限制: 不涉及 取值范围: 不涉及。 默认取值: 不涉及 |
| get_url | String | 参数解释: GET地址,用于下载文件。 约束限制: 不涉及 取值范围: 不涉及。 默认取值: 不涉及 |
| expire | Integer | 参数解释: 预签链接失效时长。 约束限制: 不涉及。 取值范围: 大于0 默认取值: 600 |
| ready | Boolean | 参数解释: 文件上传状态。 约束限制: 当前未使用该参数。 取值范围: · true:上传完成 · false:上传未完成 默认取值: 不涉及 |
| filename | String | 参数解释: 场景文件名。 约束限制: 场景文件为OpenSCENARIO格式。 取值范围: 长度范围[0-255]。 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| url | String | 参数解释: 下一页结果集资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| fields | PostResponseField object | 参数解释: 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,
"replay_filename" : null,
"user_id" : "userId",
"user_name" : "userName",
"name" : "my-scenario",
"priority" : 40,
"map" : "/v2/my_project_id/sim/sm/maps/2631662/",
"model" : null,
"replay" : null,
"source" : "UPLOAD"
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 请求成功 |
错误码
请参见错误码。