文档首页/ 自动驾驶云服务 Octopus/ API参考/ API/ 仿真场景/ 修改场景文件-UpdateSceneFile
更新时间：2026-04-30 GMT+08:00
查看PDF
分享

修改场景文件-UpdateSceneFile

获取场景详情

功能介绍

获取场景详情。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    octopus:simScenario:get

    Read

    -

    -

    -

    -

URI

GET https://{hostURL}/v2/{project_id}/sim/sm/scenarios/{id}

表1 路径参数

参数

是否必选

参数类型

描述

id

是

Integer

参数解释：

仿真场景ID。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

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

FileNestedSrlz object

参数解释：

仿真场景文件，场景文件为OpenSCENARIO格式。

约束限制：

不涉及

map

map object

参数解释：

场景地图资源地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

model

model object

参数解释：

场景3D模型资源地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

replay

replay object

参数解释：

数据回灌资源地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

simulator

String

参数解释：

仿真器名称。

约束限制：

不涉及。

version

String

参数解释：

场景对应的OpenSCENARIO版本。

约束限制：

不涉及。

取值范围：

  • vtd - vtd

  • v0.9.1 - v0.9.1

  • v1.0.0 - v1.0.0

  • v1.1.0 - v1.1.0

  • v1.1.1 - v1.1.1

默认取值：

不涉及

filename

String

参数解释：

场景文件名。

约束限制：

场景文件为OpenSCENARIO格式。

取值范围：

长度范围[0-255]。

默认取值：

不涉及

map_filename

String

参数解释：

地图文件名称。

约束限制：

地图文件为OpenDRIVE格式。

取值范围：

不涉及。

默认取值：

不涉及

model_filename

String

参数解释：

地图文件所关联的3D模型文件名称。

约束限制：

支持OSGB格式。

取值范围：

不涉及。

默认取值：

不涉及

replay_filename

String

参数解释：

数据回灌文件名称。

约束限制：

当前支持pblog格式。

取值范围：

不涉及。

默认取值：

不涉及

user_id

String

参数解释：

创建者的用户ID。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

user_name

String

参数解释：

创建者的用户名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

name

String

参数解释：

场景名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

priority

Integer

参数解释：

场景优先级取值，取值越大，优先级越高。

约束限制：

不涉及

status

Integer

参数解释：

场景状态信息：。

约束限制：

不涉及。

取值范围：

  • 0 - Released

  • 1 - Available

  • 10 - Initial

  • 11 - Unavailable

  • 12 - Releasing

  • 100 - Deprecated

默认取值：

不涉及

source

String

参数解释：

场景来源。

约束限制：

不涉及。

取值范围：

  • GENERALIZATION 泛化场景

  • ROAD 路采场景

  • UPLOAD 用户自建场景

  • BUILT_IN 内置场景

默认取值：

不涉及
表3 LabelBriefSrlz

参数

参数类型

描述

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

参数解释：

父标签名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及
表4 MutableFileSrlz

参数

参数类型

描述

content

String

描述的内容。
表5 map

参数

参数类型

描述

url

String

参数解释：

地图资源地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

id

Integer

参数解释：

地图ID。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

created_at

Double

参数解释：

创建时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

updated_at

Double

参数解释：

更新时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

file

FileNestedSrlz object

参数解释：

地图文件信息。

约束限制：

不涉及

version

String

参数解释：

地图文件对应的OpenDrive版本。

约束限制：

不涉及。

取值范围：

  • v1.4.0 - v1.4.0

  • v1.5.0 - v1.5.0

  • v1.6.0 - v1.6.0

  • v1.6.1 - v1.6.1

  • v1.7.0 - v1.7.0

默认取值：

不涉及

agreement_confirm

Boolean

参数解释：

是否同意免责声明。

约束限制：

必须为True方可使用本服务。

取值范围：

  • true：同意

  • false：不同意

默认取值：

不涉及
表6 model

参数

参数类型

描述

url

String

参数解释：

模型文件地址。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

id

Integer

参数解释：

模型文件ID。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

created_at

Double

参数解释：

创建时间。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

updated_at

Double

参数解释：

更新时间。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

file

FileNestedSrlz object

参数解释：

文件对象。

约束限制：

不涉及

format

String

参数解释：

文件格式

约束限制：

不涉及

取值范围：

  • osgb - osgb

  • fbx - fbx

默认取值：

不涉及

agreement_confirm

Boolean

参数解释：

是否同意免责声明。

约束限制：

必须为True方可使用本服务。

取值范围：

  • true：同意

  • false：不同意

默认取值：

不涉及
表7 replay

参数

参数类型

描述

url

String

参数解释：

回放文件地址。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

id

Integer

参数解释：

回放文件ID。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

created_at

Double

参数解释：

创建时间。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

updated_at

Double

参数解释：

更新时间。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

file

FileNestedSrlz object

参数解释：

文件对象。

约束限制：

不涉及。

format

String

参数解释：

文件格式

约束限制：

不涉及

取值范围：

  • pblog - pblog

默认取值：

不涉及
表8 FileNestedSrlz

参数

参数类型

描述

url

String

参数解释：

文件资源地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

sha256

String

参数解释：

文件SHA256值。

约束限制：

必须是有效的SHA256字符串，可以使用本地哈希工具计算文件的SHA256值。

取值范围：

不涉及。

默认取值：

不涉及

created_at

Double

参数解释：

创建时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

updated_at

Double

参数解释：

更新时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

path

String

参数解释：

文件在OBS桶中的路径。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

bucket

String

参数解释：

文件所在OBS桶。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

filename

String

参数解释：

场景文件名。

约束限制：

场景文件为OpenSCENARIO格式。

取值范围：

长度范围[0-255]。

默认取值：

不涉及

ready

Boolean

参数解释：

文件上传状态。

约束限制：

当前未使用该参数。

取值范围：

· true：上传完成

· false：上传未完成

默认取值：

不涉及

请求示例

获取场景详情

GET https://{endpoint}/v2/{project_id}/sim/sm/scenarios/{id}/

响应示例

状态码：200

请求成功

{
  "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",
  "filename" : null,
  "map_filename" : "ALKS_Road_straight.xodr",
  "model_filename" : null,
  "replay_filename" : null,
  "user_id" : "userId",
  "user_name" : "userName",
  "source" : "ROAD",
  "name" : "my-scenario",
  "priority" : 40,
  "status" : 0,
  "map" : "/v2/my_project_id/sim/sm/maps/2631662/",
  "model" : null,
  "replay" : null
}

状态码

状态码

描述

200

请求成功

错误码

请参见错误码。

父主题： 仿真场景

相关文档