-
响应示例 状态码:200 {
"url": "/v2/54d37c8f25af42xxxxx4ee9772687bf/sim/sm/scenarios/32050/",
"id": 32050,
"created_at": 1742353268.604604,
"updated_at": 1742353269.253803,
"labels": [
],
"gen_scenario": null,
"road_scenario": "/v2/54d37c8f25af42xxxxx4ee9772687bf/sim/sm/road-scenarios/865/",
"description": {
"content": ""
},
"file": {
"url": "/v2/54d37c8f25af42xxxxx4ee9772687bf/sim/sm/scenarios/32050/files/d3f8b502c334296765xxxxxxxx951ff42a02b71eaeb7ebd118e2898/",
"sha256": "d3f8b502c334296765xxxxxxxx951ff42a02b71eaeb7ebd118e2898",
"created_at": 1742353268.593741,
"updated_at": 1742353269.144296,
"path": "sim/ifiles/scenario/d3f8b502c334296765xxxxxxxx951ff42a02b71eaeb7ebd118e2898.xosc",
"bucket": "octopus-raw-54d37c8f25af42xxxxx4ee9772687bf",
"filename": "scenario_1742353244.xosc",
"ready": true
},
"map": {
"url": "/v2/54d37c8f25af42xxxxx4ee9772687bf/sim/sm/maps/21668/",
"id": 21668,
"created_at": 1742353260.93824,
"updated_at": 1744074022.312378,
"file": {
"url": "/v2/54d37c8f25af42xxxxx4ee9772687bf/sim/sm/maps/21668/files/15f9598b9e4a2677xxxxxxxxa7f0ed31f98da0954b0ab4171c7ec203/",
"sha256": "15f9598b9e4a2677xxxxxxxxa7f0ed31f98da0954b0ab4171c7ec203",
"created_at": 1742353260.934919,
"updated_at": 1742353261.36653,
"path": "sim/ifiles/map/15f9598b9e4a2677xxxxxxxxa7f0ed31f98da0954b0ab4171c7ec203.xodr",
"bucket": "octopus-raw-54d37c8f25af42xxxxx4ee9772687bf",
"filename": "road.xodr",
"ready": true
},
"version": "v1.5.0",
"agreement_confirm": true
},
"model": null,
"simulator": "B",
"version": "v0.9.1",
"filename": "scenario_174xxx244.xosc",
"map_filename": "road.xodr",
"model_filename": null,
"user_id": "5ffa2cb7631340xxxxx4736284af7dc4",
"user_name": "octopus_admin",
"source": "UPLOAD",
"name": "sc_7BgqxxxxuKCKwYw",
"priority": 60,
"status": 0
}
-
响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 url String 场景资源地址 id Integer 场景ID created_at TimeStamp 创建时间 updated_at TimeStamp 更新时间 labels Array of LabelBriefSrlz objects 场景标签。场景标签体系为树状结构,按照OpenLABEL标准进行设计 gen_scenario String 泛化场景资源地址 road_scenario String 路采场景资源地址 description description object 描述 file FileNestedSrlz object 场景文件信息 map map object 场景地图信息 model model object 场景模型信息 simulator String 仿真器,如:B version String 场景对应的OpenSCENARIO版本 filename String 场景文件名称 map_filename String 场景地图文件名称 model_filename String 场景模型文件名称 user_id String 用户ID user_name String 用户名称 name String 场景名称 priority Integer 优先级,取值越大,优先级越高。可从如下范围中选择: 120 – S:至关重要 100 – A:很重要 80 – B:重要 60 – C:普通 status Integer 状态信息: 0 - Released 已发布 1 - Available 可用 10 - Initial 初始化中 11 - Unavailable 不可用 12 - Releasing 发布中 100 - Deprecated 已弃用 source String 来源,如 UPLOAD - 用户上传 表4 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 objects 父标签名称 表5 description 参数 参数类型 描述 content String 描述的内容 表6 map 参数 参数类型 描述 url String 地图资源地址 id Integer 地图ID created_at TimeStamp 创建时间 updated_at TimeStamp 更新时间 file FileNestedSrlz object 地图文件信息 version String 地图版本 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 - 同意 false - 不同意 表7 model 参数 参数类型 描述 url String 模型资源地址 id Integer 模型ID created_at TimeStamp 创建时间 updated_at TimeStamp 更新时间 file FileNestedSrlz object 模型文件信息 format String 模型文件格式 osgb - osgb fbx - fbx agreement_confirm Boolean 协议确认 true - 同意 false - 不同意 表8 FileNestedSrlz 参数 参数类型 描述 url String 文件资源地址 sha256 String 文件SHA256 信息 created_at TimeStamp 创建时间 updated_at TimeStamp 更新时间 path String 文件路径信息 bucket String bucket信息 filename String 文件名称 ready Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false
-
请求示例 创建仿真场景 POST https://{endpoint}/v2/{project_id}/sim/sm/scenarios/
{
"name" : "my-scenario",
"simulator" : "B",
"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" : "B",
"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 表5 响应Body参数 参数 参数类型 描述 url String 仿真场景的资源地址。 id Integer 仿真场景ID。 created_at TimeStamp 创建时间。 updated_at TimeStamp 更新时间。 labels Array of LabelBriefSrlz objects 场景所关联的标签。场景标签体系为树状结构,按照OpenLABEL标准进行设计。 gen_scenario String 泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入,并关联到导入的泛化场景。 road_scenario String 路采场景资源地址。通过该字段判断仿真场景是否由路采场景导入,并关联到导入的路采场景。 description MutableFileSrlz object 描述的内容。 file file object 仿真场景文件,场景文件为OpenSCENARIO格式。 simulator String 仿真器,如B。 version String 场景对应的OpenSCENARIO版本。 map_filename String 地图文件名称,地图文件为OpenDRIVE格式。 model_filename String 地图文件所关联的3D模型文件名称,当前支持OSGB格式。 user_id String 用户id。 user_name String 用户名。 name String 场景名称。 priority Integer 120 - S 100 - A 80 - B 60 - C 40 - D map String 场景地图资源地址。 model String 场景3D模型资源地址。 source String UPLOAD - User upload scenario. ROAD - Road scenario. GENERALIZATION - Generalized scenario. BUILT_IN - Built-in scenario. 表6 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 objects 父标签名称。 表7 MutableFileSrlz 参数 参数类型 描述 content String 描述的内容。 表8 file 参数 参数类型 描述 url String 文件资源地址。 sha256 String 文件sha256值。 created_at TimeStamp 创建时间。 updated_at TimeStamp 更新时间。 post post object POST预签链接信息,用于上传文件。 put_url String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url String GET地址,用于下载文件。 expire Integer 默认失效时间为600秒。 ready Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。 filename String 文件名。 表9 post 参数 参数类型 描述 url String POST预签链接信息,用于上传文件。 fields PostResponseField object POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 表10 PostResponseField 参数 参数类型 描述 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字段,在创建请求时需要添加到请求头。
-
请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 gen_scenario 否 String 泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入,并关联到导入的泛化场景。 description 是 MutableFileSrlz object 描述的内容。 file 否 file object 仿真场景文件,场景文件为OpenSCENARIO格式。 simulator 是 String 仿真器,如B。 version 是 String 场景对应的OpenSCENARIO版本。 map_filename 否 String 地图文件名称,地图文件为OpenDRIVE格式。 model_filename 否 String 地图文件所关联的3D模型文件名称,当前支持OSGB格式。 user_id 否 String 用户id。 user_name 否 String 用户名。 name 是 String 场景名称。 priority 否 Integer 120 - S 100 - A 80 - B 60 - C 40 - D map 否 String 场景地图资源地址。 model 否 String 场景3D模型资源地址。 source 否 String UPLOAD - User upload scenario. ROAD - Road scenario. GENERALIZATION - Generalized scenario. BUILT_IN - Built-in scenario. 表3 MutableFileSrlz 参数 是否必选 参数类型 描述 content 是 String 描述的内容。 表4 file 参数 是否必选 参数类型 描述 sha256 是 String 文件sha256值。 filename 是 String 文件名。
-
URI PATCH https://{hostURL}/v2/{project_id}/sim/sm/scenarios/{parent_lookup_id}/files/{sha256} 表1 路径参数 参数 是否必选 参数类型 描述 parent_lookup_id 是 String 场景ID。 project_id 是 String 项目ID。 sha256 是 String 文件sha256值。
-
响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 url String 文件资源地址。 sha256 String 文件sha256值。 created_at TimeStamp 创建时间。 updated_at TimeStamp 更新时间。 post post object POST预签链接信息,用于上传文件。 put_url String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url String GET地址,用于下载文件。 expire Integer 默认失效时间为600秒。 path String 文件在OBS桶中的路径。 bucket String 文件所在OBS桶。 filename String 文件名。 ready Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。 表4 post 参数 参数类型 描述 url String POST预签链接信息,用于上传文件。 fields PostResponseField object POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 表5 PostResponseField 参数 参数类型 描述 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字段,在创建请求时需要添加到请求头。
-
响应示例 状态码:200 请求成功 {
"url" : "/v2/my_project_id/sim/sm/files/0fb50a138fb132be3c794eb423375cca3263fe35a33063c06a4821819ab7fc85/",
"sha256" : "0fb50a138fb132be3c794eb423375cca3263fe35a33063c06a4821819ab7fc85",
"created_at" : 1.699954029767271E9,
"updated_at" : 1.699954030498088E9,
"post" : null,
"put_url" : null,
"get_url" : "my-get-url",
"path" : "my-path",
"bucket" : ",my-bucket",
"filename" : "ALKS_Scenario_4.1_1_FreeDriving_TEMPLATE.xosc",
"ready" : true
}
-
请求示例 创建仿真任务 POST https://{endpoint}/v2/{project_id}/sim/pm/batches/
{
"name": "test_batches_create",
"description": "test_batches_create",
"algorithm_image": "/v2/my_project_id/sim/pm/algorithm-images/56/",
"batch_config": "/v2/my_project_id/sim/pm/batch-configs/257/"
}
-
响应示例 状态码:201 请求成功 {
"url": "/v2/my_project_id/sim/pm/batches/938/",
"id": 938,
"created_at": 1747035787.805102,
"updated_at": 1747035787.805121,
"passing_score": 60,
"algorithm_name": "kyber_to_simpro",
"algorithm_image": "/v2/my_project_id/sim/pm/algorithm-images/56/",
"algorithm_image_version": "1",
"started_at": null,
"ended_at": null,
"success": 0,
"fail": 0,
"simulation_size": 0,
"status": 100,
"name": "test_batches_create",
"description": "test_batches_create",
"user_id": "xxxx",
"designated_simulation_ids": null,
"batch_config": "/v2/my_project_id/sim/pm/batch-configs/257/"
}
-
响应参数 状态码:201 表3 响应Body参数 参数 参数类型 描述 url String 仿真任务的资源地址。 id Integer 仿真任务ID。 created_at TimeStamp 创建时间。 updated_at TimeStamp 更新时间。 passing_score Integer 融合评测通过分数。 algorithm_name String 关联算法名称。 algorithm_image String 关联算法镜像。 algorithm_image_version String 关联算法镜像版本。 started_at Double 任务开始时间。 ended_at Double 任务结束时间。 success Integer 子任务成功数量 fail Integer 子任务失败数量 simulation_size Integer 子任务数量 status Integer 任务状态: 0 - 成功 1 - 等待中 2 - 调度中 3 - 运行中 4 - 已取消 5 - 全部失败 6 - 部分失败 7 - 启动失败 8 - 任务冲突 10 - 未运行 11 - CPU不足 12 - 内存不足 13 - GPU不足 14 - 初始化集群失败 15 - 未购买SKU 31 - 超时 32 - 未知 100 - 初始化中 101 - 初始化失败 102 - 任务丢失 103 - 反馈失败 104 - 排队中 105 - 算法镜像丢失 106 - 评测镜像丢失 107 - 仿真器镜像丢失 name String 任务名称。 description String 任务描述。 user_id String 用户id。 designated_simulation_ids Array of objects 用户指定重跑子任务ids batch_config String 关联batch配置
-
响应示例 状态码: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" : "B",
"version" : "v1.0.0",
"filename" : "cutin.xosc",
"map_filename" : "city.xodr",
"model_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
} ]
}
-
响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 count Integer 列表中实例的数量。 next String 下一个分页的查询地址。 previous String 上一个分页的查询地址。 results Array of ScenarioListSrlz objects 仿真场景列表。 表4 ScenarioListSrlz 参数 参数类型 描述 url String 仿真场景的资源地址。 id Integer 仿真场景ID。 created_at TimeStamp 创建时间。 updated_at TimeStamp 更新时间。 labels Array of LabelBriefSrlz objects 场景标签。场景标签体系为树状结构,按照OpenLABEL标准进行设计。 gen_scenario String 泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入,并关联到导入的泛化场景。 road_scenario String 路采场景资源地址。通过该字段判断仿真场景是否由路采场景导入,并关联到导入的路采场景。 simulator String 仿真器,如B。 version String 场景对应的OpenSCENARIO版本。 filename String 场景文件名,场景文件为OpenSCENARIO格式。 map_filename String 地图文件名称,地图文件为OpenDRIVE格式。 model_filename String 地图文件所关联的3D模型文件名称,当前支持OSGB格式。 user_id String 用户ID。 user_name String 用户名。 name String 场景名称。 priority Integer 120 - S 100 - A 80 - B 60 - C 40 - D status Integer 0 - Released 1 - Available 10 - Initial 11 - Unavailable 12 - Releasing 100 - Deprecated map String 场景地图资源地址。 model String 场景3D模型资源地址。 source String UPLOAD - User upload scenario. ROAD - Road scenario. GENERALIZATION - Generalized scenario. BUILT_IN - Built-in scenario. 表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 objects 父标签名称。
-
URI GET https://{hostURL}/v2/{project_id}/sim/sm/scenarios 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 exclude_group 否 Integer 查询时不包括的场景组。 file 否 String 场景文件。 gen_scenario 否 String 泛化场景的资源地址。 group 否 Array of integers 场景组ID。 id 否 Integer 场景ID。 label 否 Number 标签ID。 map 否 Integer 地图ID。 name 否 String 场景名称。 ordering 否 String 用于排序的字段,查询结果会基于该字段排序。 offset 否 Integer 分页查询的偏移。 limit 否 Integer 分页查询时查询结果数量。 search 否 String 查询条件。 simulator 否 String 仿真器,如B。 source 否 String 场景来源,可选项包括: [GENERALIZATION, ROAD, UPLOAD, BUILT_IN],分别表示泛化场景,路采场景,用户自建场景和内置场景。 status 否 Integer 0 - Released 1 - Available 10 - Initial 11 - Unavailable 12 - Releasing 100 - Deprecated user_name 否 String 用户名 version 否 String 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