# 获取仿真任务配置列表-GetSimulationTaskConfigurationList #### 功能介绍 获取仿真任务配置列表。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-octopus/Permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | octopus:simBatch:list | List | - | - | - | - | #### URI GET https://{hostURL}/v2/{project_id}/sim/pm/batch-configs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-octopus/octopus-10-0020.html)。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | algorithm_id | 否 | Integer | **参数解释**： 按照算法ID过滤。 **约束限制**： 需要确保算法存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | algorithm_name | 否 | String | **参数解释**： 按照算法名称过滤。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | builtins_algorithm | 否 | Boolean | **参数解释**： 按照是否为仿真器内置算法过滤。 **约束限制**： 不涉及 **取值范围**： · true：是仿真器内置算法 · false：非仿真器内置算法 **默认取值**： 不涉及 | | custom_evaluation_image_id | 否 | Integer | **参数解释**： 按照自定义评测镜像ID过滤。 **约束限制**： 需要确保自定义评测镜像存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | custom_simulator_image_id | 否 | Integer | **参数解释**： 按照仿真器镜像ID过滤。 **约束限制**： 需要确保仿真器镜像存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | description | 否 | String | **参数解释**： 描述。 **约束限制**： 不涉及 **取值范围**： 最大长度256位，支持中文，字母，数字及下划线命名。 **默认取值**： 不涉及 | | evaluation_id | 否 | Integer | **参数解释**： 按照评测ID过滤。 **约束限制**： 需要确保评测存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | evaluation_name | 否 | String | **参数解释**： 按照评测名称过滤。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | generalization_id | 否 | Integer | **参数解释**： 按照泛化任务ID过滤。 **约束限制**： 需要确保泛化任务存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | group_id | 否 | Integer | **参数解释**： 按照场景库ID过滤。 **约束限制**： 需要确保场景库I存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | id | 否 | Integer | **参数解释**： 按照仿真配置ID过滤。 **约束限制**： 需要确保仿真配置存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | limit | 否 | Integer | **参数解释**： 返回个数上限。 **约束限制**： 不涉及 **取值范围**： \[0-100\] **默认取值**： 10 | | name | 否 | String | **参数解释**： 按照仿真配置名称过滤。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | offset | 否 | Integer | **参数解释**： 查询偏移量。 **约束限制**： 不涉及 **取值范围**： 大于等于0 **默认取值**： 0 | | ordering | 否 | String | **参数解释**： 查询结果的排序方式。 **约束限制**： 不涉及 **取值范围**： 默认升序，-为降序 - id： 根据id排序 - created_at： 根据创建时间排序 **默认取值**： 无 | | search | 否 | String | **参数解释**： 对仿真任务配置名称进行模糊搜索。 **约束限制**： 不涉及。 **取值范围**： 只能由中文字符、英文字母、数字组成的字符。 **默认取值**： 不涉及 | | suit_id | 否 | Integer | **参数解释**： 按照测试套件ID过滤。 **约束限制**： 需要确保测试套件存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | triggerable | 否 | Boolean | **参数解释**： 按照是否可通过流水线功能触发过滤。 **约束限制**： 不涉及。 **取值范围**： · true：自动触发 · false：不自动触发 **默认取值**： 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释**： 成员总量。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | next | String | **参数解释**： 下一页结果集资源地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | previous | String | **参数解释**： 上一页结果集资源地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | results | Array of [BatchConfigSrlz] objects | **参数解释**： 当前页结果集信息。 **约束限制**： 不涉及 | 表4BatchConfigSrlz | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | **参数解释**： 仿真任务配置的资源地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | id | Integer | **参数解释**： 仿真任务配置ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | created_at | Double | **参数解释**： 创建时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | updated_at | Double | **参数解释**： 更新时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | algorithm | String | **参数解释**： 关联算法资源地址。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | algorithm_name | String | **参数解释**： 算法名称。 **约束限制**： 不涉及 **取值范围**： 长度\[0-256\] **默认取值**： 不涉及 | | builtins_evaluation | Boolean | **参数解释**： 是否使用内置评测。 **约束限制**： 不涉及 **取值范围**： - *true* - 使用内置评测 - *false* - 不使用内置评测 **默认取值**： 不涉及 | | custom_evaluation_image | String | **参数解释**： 关联评测镜像资源地址。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | custom_simulator_image_id | Integer | **参数解释**： 镜像管理中的仿真器镜像的版本id。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | evaluation_info | [BatchConfigEvaluationInfoSrlz] object | **参数解释**： 评测配置信息。 **约束限制**： 不涉及 | | batch_size | Integer | **参数解释**： 任务数量。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | duration | String | **参数解释**： 子任务最大运行时长，输出是时间格式，比如"0:10:0"表示超时时间10分钟。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | repeat_times | Integer | **参数解释**： 重复运行次数。 **约束限制**： 不涉及 **取值范围**： 最小1次，最大100000次。 **默认取值**： 不涉及 | | user_id | String | **参数解释**： 用户id，从统一身份认证中获取。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | name | String | **参数解释**： 仿真任务配置名称。 **约束限制**： 不涉及 **取值范围**： 最大长度64位，支持中文，字母，数字及下划线命名。 **默认取值**： 不涉及 | | description | String | **参数解释**： 仿真任务配置描述。 **约束限制**： 不涉及 **取值范围**： 最大长度256位，支持中文，字母，数字及下划线命名。 **默认取值**： 不涉及 | | simulator_name | String | **参数解释**： 仿真器名称。 **约束限制**： 不涉及 **取值范围**： \["A", "B", "C", "E", "F"\]等仿真器类型 **默认取值**： 不涉及 | | record_mode | Integer | **参数解释**： 录制模式，启动录制后方可下载算法日志以及仿真日志。 **约束限制**： 不涉及 **取值范围**： - *0* - 不录制 - *1* - 录制 **默认取值**： 不涉及 | | priority | Integer | **参数解释**： 优先级,取值越大，优先级越高。 **约束限制**： 不涉及 **取值范围**： - *120* - S：至关重要 - *100* - A：很重要 - *80* - B：重要 - *60* - C：普通 **默认取值**： 不涉及 | | datahub | Boolean | **参数解释**： 是否使用datahub。 **约束限制**： 不涉及 **取值范围**： - True：使用Datahub - False：不使用Datahub **默认取值**： False | | passing_score | Integer | **参数解释**： 融合评测通过分数。 **约束限制**： 不涉及 **取值范围**： 范围\[0-100\] **默认取值**： 60 | | triggerable | Boolean | **参数解释**： 是否可通过流水线功能触发。 **约束限制**： 不涉及 **取值范围**： - True：通过流水线功能触发 - False：不通过流水线功能触发 **默认取值**： False | | evaluations | Array of strings | **参数解释**： 关联评测管理项目，评测管理的链接列表。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | simulator_config | String | **参数解释**： 仿真器配置信息。 **约束限制**： 不涉及 **取值范围**： 长度范围\[0-256\] **默认取值**： 不涉及 | | scenario_type | Integer | **参数解释**： 场景库类型。 **约束限制**： 不涉及 **取值范围**： - *0* - 场景库：从场景库选择场景 - *1* - 逻辑场景：从泛化任务选择任务 - *2* - 测试套件：从测试套件选择场景 **默认取值**： *0* | | scenario_set_id | Integer | **参数解释**： 场景库 id。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | scenarios | [BatchConfigScenarioSrlz] object | **参数解释**： 场景信息。 **约束限制**： 不涉及 | | simulator_command | String | **参数解释**： 仿真器运行命令。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0-256\]的ASCII字符。 **默认取值**： 不涉及 | | modal_type | String | **参数解释**： 端到端仿真模态类型。 **约束限制**： 不涉及。 **取值范围**： 目前只支持相机类型 CAMERA。 **默认取值**： 不涉及 | | model_id | String | **参数解释**： 端到端仿真模型ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | model_version | String | **参数解释**： 端到端仿真模型版本。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表5BatchConfigEvaluationInfoSrlz | 参数 | 参数类型 | 描述 | |:---|:---|:---| | image | [BatchConfigImageInfoSrlz] object | **参数解释**： 镜像信息 **约束限制**： 不涉及 | 表6BatchConfigImageInfoSrlz | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释**： 镜像资源ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | name | String | **参数解释**： 镜像资源名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | image_id | Integer | **参数解释**： 镜像ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | image_version | String | **参数解释**： 镜像版本，如"1.0"。 **约束限制**： 不涉及。 **取值范围**： 长度\[0-256\] **默认取值**： 不涉及 | 表7record_mode | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | Integer | **参数解释**： 录制模式，启动录制后方可下载算法日志以及仿真日志。 **约束限制**： 不涉及 **取值范围**： - *0* - 不录制 - *1* - 录制 **默认取值**： 不涉及 | 表8priority | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | Integer | **参数解释**： 优先级,取值越大，优先级越高。 **约束限制**： 不涉及 **取值范围**： - *120* - S：至关重要 - *100* - A：很重要 - *80* - B：重要 - *60* - C：普通 **默认取值**： 不涉及 | 表9BatchConfigScenarioSrlz | 参数 | 参数类型 | 描述 | |:---|:---|:---| | group_ids | Array of integers | **参数解释**： 场景库ID信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | generalization_ids | Array of integers | **参数解释**： 泛化任务ID信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | suit_ids | Array of integers | **参数解释**： 测试套件ID信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求示例 获取仿真任务配置列表 ``` GET https://{endpoint}/v2/{project_id}/sim/pm/batch-configs?offset=0&limit=10 ``` #### 响应示例 **状态码：200** ``` { "count" : 1, "next" : null, "previous" : null, "results" : [ { "url" : "/v2/my_project_id/sim/pm/batch-configs/177/", "id" : 177, "created_at" : 1.699954029767271E9, "updated_at" : 1.699954030498088E9, "algorithm" : "/v2/my_project_id/sim/pm/algorithms/5/", "algorithm_name" : "my-algorithm-x5", "builtins_evaluation" : true, "custom_evaluation_image" : null, "custom_simulator_image_id" : null, "evaluation_info" : { "CONFIG" : { "id" : 42, "name" : "内置指标" } }, "batch_size" : 1, "duration" : "00:01:00", "repeat_times" : 1, "user_id" : "my_user_id", "name" : "my_batch_config_x1", "description" : "my_batch_config_x1", "simulator_name" : "SimPro", "record_mode" : 1, "priority" : 60, "datahub" : false, "passing_score" : 60, "scenario_type" : 0, "scenario_set_id" : 39, "triggerable" : false, "evaluations" : [ "/v2/my_project_id/sim/pm/evaluations/42/" ] } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-octopus/ErrorCode.html)。