更新时间:2024-05-09 GMT+08:00
分享

列举study所有作业

功能介绍

列举study所有作业

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id}/jobs

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

String

平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。

最小长度:1

最大长度:128

project_id

String

华为云项目ID,您可以从获取项目ID中获取。

最小长度:1

最大长度:128

study_id

String

study_id

最小长度:1

最大长度:128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

作业总数

jobs

Array of StudyJobRsp objects

作业列表

表4 StudyJobRsp

参数

参数类型

描述

id

String

study作业id

workflow_job_id

String

workflow作业id

name

String

作业名称

status

String

作业状态

template_id

String

生成study作业结果的模板id

database_name

String

study作业结果的数据库实例名称

database_id

String

study作业结果的数据库实例id

relative_path

String

生成study作业结果的文件的相对路径

output_file_type

String

生成study作业结果的文件的类型

workflow_name

String

使用的workflow名称

label

String

使用的workflow标签

create_time

String

作业创建时间

update_time

String

作业更新时间

请求示例

查询药筛作业列表

https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id}/jobs

响应示例

状态码: 200

OK

{
  "count" : 1,
  "jobs" : [ {
    "id" : "78dfce53-0303-4b46-a2d9-4a067812b289",
    "workflow_job_id" : "78dfce53-0303-4b46-a2d9-4a067812b289",
    "name" : "study-job",
    "status" : "RUNNING",
    "template_id" : "24dfce53-0303-4b46-a2d9-4a067812b289",
    "database_name" : "demo-database",
    "database_id" : "4f7fce53-0303-4b46-a2d9-4a067812b289",
    "relative_path" : "/docking-summary",
    "output_file_type" : "csv",
    "workflow_name" : "docking-summary",
    "label" : "small-molecular-chemicals",
    "create_time" : "2021-02-22T07:07:41Z",
    "update_time" : "2021-02-22T07:07:41Z"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档