更新时间:2026-04-30 GMT+08:00
分享

查询场景列表-ScenarioList

功能介绍

本接口用于查询基于OpenSCENARIO标准的仿真场景列表。支持OpenSCENARIO 0.9.1 - 1.1.1 版本的场景。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    octopus:simScenario:list

    List

    -

    -

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

exclude_group

否

Integer

参数解释:

查询时不包括的场景库。

约束限制:

必须是存在的场景库id。

取值范围:

不涉及

默认取值:

不涉及

file

否

String

参数解释:

场景文件资源url。

约束限制:

必须是已创建的场景文件url,可以通过 创建场景文件-CreateSceneFile 创建新的场景文件。

取值范围:

不涉及。

默认取值:

不涉及

gen_scenario

否

String

参数解释:

泛化场景的资源url。

约束限制:

必须是已创建的泛化场景的资源url。

取值范围:

不涉及。

默认取值:

不涉及

group

否

Array of integers

参数解释:

场景组ID。

约束限制:

不涉及。

取值范围:

不涉及

默认取值:

不涉及

id

否

Integer

参数解释:

场景ID。

约束限制:

不涉及。

取值范围:

不涉及

默认取值:

不涉及

label

否

Number

参数解释:

标签ID。

约束限制:

不涉及。

取值范围:

不涉及

默认取值:

不涉及

map

否

Integer

参数解释:

地图ID。

约束限制:

不涉及。

取值范围:

不涉及

默认取值:

不涉及

name

否

String

参数解释:

场景名称。

约束限制:

不涉及。

取值范围:

只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为[1-256]个字符。

默认取值:

不涉及

ordering

否

String

参数解释:

用于排序的字段,查询结果会基于该字段排序。

约束限制:

不涉及。

取值范围:

默认升序,-为降序

  • id: 根据id排序

  • created_at: 根据创建时间排序

默认取值:

无

offset

否

Integer

参数解释:

分页查询的偏移。

约束限制:

不涉及。

取值范围:

大于等于0

默认取值:

0

limit

否

Integer

参数解释:

分页查询时查询结果数量。

约束限制:

不涉及。

取值范围:

[0-100]

默认取值:

10

search

否

String

参数解释:

对场景名称进行模糊搜索。

约束限制:

不涉及。

取值范围:

只能由中文字符、英文字母、数字组成的字符。

默认取值:

不涉及

simulator

否

String

参数解释:

仿真器名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

source

否

String

参数解释:

场景来源。

约束限制:

不涉及。

取值范围:

  • GENERALIZATION 泛化场景

  • ROAD 路采场景

  • UPLOAD 用户自建场景

  • BUILT_IN 内置场景

默认取值:

不涉及

status

否

Integer

参数解释:

场景状态信息:。

约束限制:

不涉及。

取值范围:

  • 0 - Released

  • 1 - Available

  • 10 - Initial

  • 11 - Unavailable

  • 12 - Releasing

  • 100 - Deprecated

默认取值:

不涉及

user_name

否

String

参数解释:

创建者的用户名。

约束限制:

不涉及。

取值范围:

只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为[1-64]个字符。

默认取值:

不涉及

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

默认取值:

不涉及

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

count

Integer

参数解释:

成员总量。

约束限制:

不涉及。

取值范围:

不涉及

默认取值:

不涉及

next

String

参数解释:

下一页结果集资源地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

previous

String

参数解释:

上一页结果集资源地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

results

Array of ScenarioListSrlz objects

仿真场景列表。

表4 ScenarioListSrlz

参数

参数类型

描述

url

String

参数解释:

仿真场景的资源地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

id

Integer

参数解释:

仿真场景ID。

约束限制:

不涉及。

取值范围:

不涉及

默认取值:

不涉及

created_at

Double

参数解释:

创建时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

updated_at

Double

参数解释:

更新时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

labels

Array of LabelBriefSrlz objects

参数解释:

场景标签。

约束限制:

场景标签体系为树状结构,按照OpenLABEL标准进行设计。

gen_scenario

String

参数解释:

泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入,并关联到导入的泛化场景。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

road_scenario

String

参数解释:

路采场景资源地址。通过该字段判断仿真场景是否由路采场景导入,并关联到导入的路采场景。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

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格式。

取值范围:

不涉及。

默认取值:

不涉及

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

参数解释:

场景状态信息。

约束限制:

不涉及

map

String

参数解释:

场景地图资源地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

model

String

参数解释:

场景3D模型资源地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

replay

String

参数解释:

数据回灌资源地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

source

String

参数解释:

场景来源。

约束限制:

不涉及

表5 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

参数解释:

父标签名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

请求示例

无

响应示例

状态码: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" : "MySimulator",
    "version" : "v1.0.0",
    "filename" : "cutin.xosc",
    "map_filename" : "city.xodr",
    "model_filename" : null,
    "replay_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,
    "replay" : null
  } ]
}

状态码

状态码

描述

200

请求成功

错误码

请参见错误码。

相关文档