获取仿真任务列表-GetSimulationTaskList
功能介绍
获取仿真任务列表。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:simBatch:list
List
-
-
-
-
URI
GET https://{hostURL}/v2/{project_id}/sim/pm/batches
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| algorithm_image_version | 否 | String | 参数解释: 按照算法镜像版本过滤。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| algorithm_name | 否 | String | 参数解释: 按照算法名称过滤。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| batch_config_id | 否 | Integer | 参数解释: 按照关联的仿真配置ID筛选。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| description | 否 | String | 参数解释: 按照描述内容筛选。 约束限制: 不涉及。 取值范围: 只能由中文字符、英文字母、数字组成的字符。 默认取值: 不涉及 |
| generalization_id | 否 | Integer | 参数解释: 按照泛化任务ID筛选。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| id | 否 | Integer | 参数解释: 按照仿真任务ID筛选。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 返回个数上限。 约束限制: 不涉及 取值范围: [0-100] 默认取值: 10 |
| name | 否 | String | 参数解释: 按照仿真任务配置名称筛选。 约束限制: 不涉及 取值范围: 最大长度64位,支持中文,字母,数字及下划线命名。 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 查询偏移量。 约束限制: 不涉及 取值范围: 大于等于0 默认取值: 0 |
| ordering | 否 | String | 参数解释: 查询结果的排序方式。 约束限制: 不涉及 取值范围: 默认升序,-为降序 默认取值: 无 |
| search | 否 | String | 参数解释: 对仿真任务名称进行模糊搜索。 约束限制: 不涉及。 取值范围: 只能由中文字符、英文字母、数字组成的字符。 默认取值: 不涉及 |
| status | 否 | Integer | 参数解释: 按照场景状态信息筛选。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | Integer | 参数解释: 成员总量。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| next | String | 参数解释: 下一页结果集资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| previous | String | 参数解释: 上一页结果集资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| results | Array of BatchSrlz objects | 参数解释: 当前页结果集信息。 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| url | String | 参数解释: 仿真任务的资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| id | Integer | 参数解释: 仿真任务ID。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| created_at | Double | 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| updated_at | Double | 参数解释: 更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| passing_score | Integer | 参数解释: 融合评测通过分数。 约束限制: 不涉及 取值范围: 范围[0-100] 默认取值: 60 |
| algorithm_name | String | 参数解释: 算法名称。 约束限制: 不涉及 取值范围: 长度[0-256] 默认取值: 不涉及 |
| algorithm_image | String | 参数解释: 关联算法镜像URL。 约束限制: 不涉及 取值范围: 长度[0-1024] 默认取值: 不涉及 |
| algorithm_image_version | String | 参数解释: 关联算法镜像版本。 约束限制: 不涉及 取值范围: 长度[0-1024] 默认取值: 不涉及 |
| started_at | Double | 参数解释: 任务开始时间戳。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| ended_at | Double | 参数解释: 任务结束时间戳。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| success | Integer | 参数解释: 子任务成功数量。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| fail | Integer | 参数解释: 子任务失败数量。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| simulation_size | Integer | 参数解释: 子任务数量。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| name | String | 参数解释: 仿真任务名称。 约束限制: 不涉及 取值范围: 最大长度64位,支持中文,字母,数字及下划线命名。 默认取值: 不涉及 |
| description | String | 参数解释: 仿真任务描述。 约束限制: 不涉及 取值范围: 最大长度256位,支持中文,字母,数字及下划线命名。 默认取值: 不涉及 |
| status | status object | 参数解释: 按照仿真状态信息筛选。 约束限制: 不涉及 |
| user_id | String | 参数解释: 用户id,从统一身份认证中获取。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| designated_simulation_ids | Array of integers | 参数解释: 用户指定重跑子任务IDs。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| batch_config | String | 参数解释: 关联仿真任务配置的资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。