更新时间:2025-12-26 GMT+08:00
分享

获取药物作业列表 - ListDrugJob

功能介绍

获取药物作业列表。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

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,您可以从获取空间ID中获取。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

限制量,单次查询总量。

约束限制:

不涉及

取值范围:

1-1000

默认取值:

100

offset

否

Integer

参数解释:

偏移量,查询起始偏移。

约束限制:

不涉及

取值范围:

0-100000000

默认取值:

0

sort_dir

否

String

参数解释:

排序规则。

约束限制:

不涉及

取值范围:

  • ASC:升序

  • DESC:降序

默认取值:

DESC

sort_key

否

String

参数解释:

排序规则,支持根据create_time|finish_time|running_time|total_time排序。

约束限制:

不涉及

取值范围:

  • create_time:根据创建时间排序。

  • finish_time:根据完成时间排序。

  • running_time:根据运行时间排序。

  • total_time:根据总时间排序。

默认取值:

不涉及

job_name

否

String

参数解释:

作业名称。

约束限制:

不涉及

取值范围:

长度为[1-128]个字符。

默认取值:

不涉及

labels

否

Array of strings

参数解释:

标签列表。

约束限制:

标签最多5个,支持中文、英文、数字、下划线和中划线,且不支持空格,每个标签长度为[1-32]个字符。

取值范围:

不涉及

默认取值:

不涉及

status_list

否

Array of strings

参数解释:

作业运行状态列表。

约束限制:

运行状态最多支持10个,仅支持WAITING|RUNNING|FINISHED|FAILED|CANCELLED。

取值范围:

  • WAITING:等待中

  • RUNNING:运行中

  • FINISHED:完成

  • FAILED:失败

  • CANCELLED:取消

默认取值:

不涉及

type_list

否

Array of strings

参数解释:

作业类型列表。

约束限制:

作业类型最多支持10个,多个作业类型之间使用逗号分隔,仅支持DOCKING|OPTIMIZATION|ADMET|POC_MOL_DESIGN|SEARCH|GENERATION|CPI|FEP|POCKET_DETECTION|TARGET_OPT|CLUSTERING。

取值范围:

  • DOCKING:分子对接

  • OPTIMIZATION:分子优化

  • ADMET:分子属性预测

  • POC_MOL_DESIGN:靶点口袋分子设计

  • SEARCH:分子搜索

  • GENERATION:分子生成

  • CPI:CPI预测

  • FEP:自由能微扰

  • POCKET_DETECTION:靶点口袋发现

  • TARGET_OPT:靶点优化

  • CLUSTERING:聚类分析

默认取值:

不涉及

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。

约束限制:

不涉及

取值范围:

  • ONE_DAY_MORE:1天以上。

  • ONE_DAY:1天内。

  • ONE_HOUR:1小时内。

  • TWELVE_HOUR:12小时内。

默认取值:

不涉及

请求参数

表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

参数解释:

作业总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

running_count

Integer

参数解释:

运行中作业总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

waiting_count

Integer

参数解释:

等待中作业总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 DrugJobDto

参数

参数类型

描述

id

String

参数解释:

作业ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

作业的名称。

约束限制:

长度为[1-63]个字符,允许大小写字母、数字、以及特殊字符中划线(-)。

取值范围:

不涉及

默认取值:

不涉及

eihealth_project_id

String

参数解释:

作业所属空间ID,您可以从获取空间ID中获取。

约束限制:

不涉及

取值范围:

长度为[1-63]个字符,允许大小写字母、数字、以及特殊字符中划线(-)。

默认取值:

不涉及

eihealth_project_name

String

参数解释:

作业所属空间名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

labels

Array of strings

参数解释:

作业标签。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

status

String

参数解释:

作业状态。

约束限制:

不涉及

取值范围:

  • WAITING:等待中

  • RUNNING:运行中

  • FINISHED:完成

  • FAILED:失败

  • CANCELLED:取消

默认取值:

不涉及

type

String

参数解释:

作业类型。

约束限制:

不涉及

取值范围:

  • DOCKING:分子对接

  • OPTIMIZATION:分子优化

  • ADMET:分子属性预测

  • POC_MOL_DESIGN:靶点口袋分子设计

  • SEARCH:分子搜索

  • GENERATION:分子生成

  • CPI:CPI预测

  • FEP:自由能微扰

  • POCKET_DETECTION:靶点口袋发现

  • TARGET_OPT:靶点优化

  • CLUSTERING:聚类分析

默认取值:

不涉及

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

参数解释:

作业进度信息。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

upstream_job_info

String

参数解释:

上游作业信息。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 Progress

参数

参数类型

描述

overall

Float

参数解释:

整体进度。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

estimated_finish_time

Long

参数解释:

预计结束时间,毫秒。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

获取药物作业列表,查询起始偏移为0,单次查询总量为10。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs?imit=10&offset=0

响应示例

状态码: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

错误码

请参见错误码。

相关文档