You need to enable JavaScript to run this app.
导航
生信操作系统Bio-OS
  • 文档首页
    • /
  • 生信操作系统Bio-OS

ListTasks

最近更新时间：2024.01.04 09:53:15

首次发布时间：2023.02.10 20:00:03

我的收藏
ListTasks

获取工作流运行任务列表

接口说明

模块：工作流运行任务管理
类型：open
场景：公有云

请求参数

参数名称类型是否必选示例值描述
ActionString是ListTasks公共参数，本接口值：ListTasks
VersionString是2021-03-04公共参数，本接口值：2021-03-04
RunIDString是rcxxxxxxxxxxxxxxxxxxx运行记录 ID
PageNumberInteger否1分页页码
PageSizeInteger否10分页页长
WorkspaceIDString是wcxxxxxxxxxxxxxxxxxxx工作空间 ID

请求示例

POST /?Action=ListTasks&Version=2021-03-04
Content-Type:application/json
{
    "RunID": "rcxxxxxxxxxxxxxxxxxxx",
    "PageNumber": 1,
    "PageSize": 10,
    "WorkspaceID": "wcxxxxxxxxxxxxxxxxxxx"
}

返回参数

参数名称类型示例值描述
ItemsArray of TaskItem投递记录列表
PageNumberInteger1分页页码
PageSizeInteger10分页页长
TotalCountInteger100总条数

TaskItem

参数名称类型示例值描述
NameStringname任务名称
RunIDStringrcxxxxxxxxxxxxxxxxxxx运行记录 ID
StatusStringSucceeded任务状态，Succeeded -> 分析成功, Failed -> 分析失败, Running -> 分析中, Queued -> 排队中, Initializing -> 启动中, Cancelled -> 已终止
StartTimeObject
Timestamp		1687143483起始时间
FinishTimeObject
Timestamp		1687143668截止时间
DurationLong185分析耗时(单位为s)
LogStrings3://bioos-wcxxxxxxxxxxxxxxxxxxx/analysis/scxxxxxxxxxxxxxxxxxxx/workflow.941846fb-158d-4d49-82e0-f2f39372e9e3.log任务日志存储路径
StdoutStrings3://bioos-wcxxxxxxxxxxxxxxxxxxx/analysis/scxxxxxxxxxxxxxxxxxxx/melt/cd28ec5b-75df-4981-a7f5-90f1deba8a94/call-step1/shard-0/execution/stdout任务输出存储路径
StderrStrings3://bioos-wcxxxxxxxxxxxxxxxxxxx/analysis/scxxxxxxxxxxxxxxxxxxx/melt/cd28ec5b-75df-4981-a7f5-90f1deba8a94/call-step1/shard-0/execution/stderr任务错误存储路径
ExecuteDurationLong实际运行分析耗时(单位为s)
JobNameStringtask-20a71d48-ex-00job名称
resourceClaimedObject
ResourceList		资源申领
resourceUsedObject
ResourceList		资源消耗

ResourceList

参数名称类型示例值描述
CPUCoreObject
double		1CPU 核数
MemoryGiBObject
double		2内存大小，单位GiB
StorageGiBObject
double		2存储大小，单位GiB
GPUGiBObject
double		2GPU显存大小，单位GiB

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListTasks",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Name": "name",
                "RunID": "rcxxxxxxxxxxxxxxxxxxx",
                "Status": "Succeeded",
                "StartTime": ,
                "FinishTime": ,
                "Duration": 185,
                "Log": "s3://bioos-wcxxxxxxxxxxxxxxxxxxx/analysis/scxxxxxxxxxxxxxxxxxxx/workflow.941846fb-158d-4d49-82e0-f2f39372e9e3.log",
                "Stdout": "s3://bioos-wcxxxxxxxxxxxxxxxxxxx/analysis/scxxxxxxxxxxxxxxxxxxx/melt/cd28ec5b-75df-4981-a7f5-90f1deba8a94/call-step1/shard-0/execution/stdout",
                "Stderr": "s3://bioos-wcxxxxxxxxxxxxxxxxxxx/analysis/scxxxxxxxxxxxxxxxxxxx/melt/cd28ec5b-75df-4981-a7f5-90f1deba8a94/call-step1/shard-0/execution/stderr",
                "ExecuteDuration": 88888888,
                "JobName": "task-20a71d48-ex-00",
                "resourceClaimed": {
                    "CPUCore": ,
                    "MemoryGiB": ,
                    "StorageGiB": ,
                    "GPUGiB": 
                },
                "resourceUsed": {
                    "CPUCore": ,
                    "MemoryGiB": ,
                    "StorageGiB": ,
                    "GPUGiB": 
                }
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 100
    }
}

错误码

HTTP 状态码错误码错误信息描述
400ParamErr<透传错误内容>参数错误
500InternalErr<透传错误内容>内部错误