更新时间:2024-07-12 GMT+08:00
分享

获取药物作业列表

功能介绍

获取药物作业列表。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:128

eihealth_project_id

String

平台项目ID。

最小长度:1

最大长度:128

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

限制量,单次查询总量,必须由数字组成,默认为100,取值范围[1,1000]。

最小值:1

最大值:1000

缺省值:100

offset

Integer

偏移量,查询起始偏移,必须由数字组成,默认为0,取值范围[0,100000000]。

最小值:0

最大值:100000000

缺省值:0

sort_dir

String

排序规则 目前默认时间降序。

缺省值:DESC

sort_key

String

排序规则 目前默认时间降序,支持根据create_time|finish_time|running_time|total_time排序。

job_name

String

作业名称。

最小长度:1

最大长度:128

labels

Array

标签列表。

最小长度:1

最大长度:32

数组长度:0 - 5

status_list

Array

作业运行状态列表, 支持WAITING|RUNNING|FINISHED|FAILED|CANCELLED。

数组长度:0 - 10

type_list

Array

作业类型列表, 支持DOCKING|OPTIMIZATION|SYNTHESIS|FEP|POCKET_DETECTION|ADMET|SEARCH|POC_MOL_DESIGN|GENERATION|CPI|TARGET_OPT。

数组长度:0 - 10

create_start_time

Long

最小创建时间。

最小值:1000000000000

最大值:9999999999999

create_end_time

Long

最大创建时间。

最小值:1000000000000

最大值:9999999999999

finish_start_time

Long

最小结束时间。

最小值:1000000000000

最大值:9999999999999

finish_end_time

Long

最大结束时间。

最小值:1000000000000

最大值:9999999999999

total_time_range

String

总运行时长, 支持ONE_DAY_MORE|ONE_DAY|ONE_HOUR|TWELVE_HOUR。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:32768

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

jobs

Array of DrugJobDto objects

作业列表。

count

Integer

作业总数。

表5 DrugJobDto

参数

参数类型

描述

id

String

作业id。

name

String

作业的名称,取值范围:[1,63],允许大小写字母、数字、以及特殊字符中划线(-)。

labels

Array of strings

作业标签。

status

String

作业状态。

type

String

作业类型。

create_time

String

作业创建时间。

finish_time

String

作业结束时间。

start_time

String

作业开始时间。

failed_message

String

失败提示,当作业执行失败时会返回。

user_name

String

创建任务的用户名称。

output_dir

String

作业结果输出目录。

expect_charge_num

Double

预估功能调用消耗次数。

real_charge_num

Double

实际功能调用消耗次数。

progress

Progress object

作业进度信息。

表6 Progress

参数

参数类型

描述

overall

Float

整体进度。

estimated_finish_time

Long

预计结束时间,毫秒。

请求示例

响应示例

状态码: 200

OK

{
  "jobs" : [ {
    "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
    "name" : "demo-job",
    "labels" : [ "labelA", "labelB" ],
    "status" : "FINISHED",
    "type" : "OPTIMIZATION",
    "create_time" : "2021-01-30T02:34:36Z",
    "start_time" : "2021-01-30T02:34:37Z",
    "finish_time" : "2021-01-30T02:53:26Z",
    "failed_message" : "null",
    "user_name" : "demo-user-name",
    "output_dir" : "job-analysis/job-name",
    "expect_charge_num" : 1,
    "real_charge_num" : 1
  } ],
  "count" : 1
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档