文档首页/ 自动驾驶云服务 Octopus/ API参考/ API/ 场景库/ 场景库列表-SceneLibraryList
更新时间：2026-04-30 GMT+08:00
查看PDF
分享

场景库列表-SceneLibraryList

功能介绍

场景库列表。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    octopus:simScenario:list

    List

    -

    -

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

description

否

Integer

参数解释：

按照描述ID筛选。

约束限制：

不涉及。

取值范围：

大于等于0

默认取值：

0

id

否

Integer

参数解释：

按照ID筛选。

约束限制：

不涉及。

取值范围：

大于等于0

默认取值：

0

name

否

String

参数解释：

按场景库名称筛选。

约束限制：

不涉及

取值范围：

支持中文，字母，数字及下划线，长度范围[1-64]。

默认取值：

不涉及

ordering

否

String

参数解释：

查询结果的排序方式。

约束限制：

不涉及。

取值范围：

默认升序，-为降序

  • id： 根据id排序

  • created_at： 根据创建时间排序

默认取值：

无

offset

否

Integer

参数解释：

查询偏移量。

约束限制：

不涉及。

取值范围：

大于等于0

默认取值：

0

limit

否

Integer

参数解释：

返回个数上限。

约束限制：

不涉及。

取值范围：

[0-100]

默认取值：

10

parent

否

Integer

参数解释：

父级场景库分类ID。

约束限制：

场景库的父级是场景库分类。

取值范围：

大于等于0

默认取值：

不涉及

scenarios

否

Array of integers

参数解释：

按照所含的场景的ID筛选。

约束限制：

不涉及。

取值范围：

大于等于0

默认取值：

0

search

否

String

参数解释：

对场景库进行模糊搜索。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及

simulator

否

String

参数解释：

仿真器名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：

成员总量。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

next

String

参数解释：

下一页结果集资源地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

previous

String

参数解释：

上一页结果集资源地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

results

Array of GroupListSrlz objects

A DRF serializer for Group.
表4 GroupListSrlz

参数

参数类型

描述

url

String

参数解释：

场景库资源地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

id

Integer

参数解释：

场景库ID。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

created_at

Double

参数解释：

创建时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

updated_at

Double

参数解释：

更新时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

count

Integer

参数解释：

场景库内场景数量。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

场景库名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及

simulator

String

参数解释：

仿真器名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

user_id

String

参数解释：

创建者的用户ID。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

user_name

String

参数解释：

场景名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

parent

String

参数解释：

父级场景库分类地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

请求示例

场景库列表

GET https://{endpoint}/v2/{project_id}/sim/sm/groups/

响应示例

状态码：200

请求成功

{
  "count" : 1,
  "next" : null,
  "previous" : null,
  "results" : [ {
    "url" : "/v2/my_project_id/sim/sm/groups/30/",
    "id" : 30,
    "created_at" : 1.699954029767271E9,
    "updated_at" : 1.699954030498088E9,
    "count" : 0,
    "name" : "my-group-x1",
    "simulator" : "VTD",
    "user_id" : "my_user_id",
    "user_name" : "octopus_user",
    "parent" : "/v2/my_project_id/sim/sm/groups/29/"
  } ]
}

状态码

状态码

描述

200

请求成功

错误码

请参见错误码。

父主题： 场景库

相关文档