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

查询分子对接作业详情

功能介绍

查询分子对接作业详情。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

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

默认取值

不涉及

eihealth_project_id

String

参数解释

空间ID。

约束限制

不涉及

取值范围

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

默认取值

不涉及

job_id

String

参数解释

作业ID。

约束限制

不涉及

取值范围

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

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

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

约束限制

不涉及

取值范围

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

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

basic_info

DrugJobDto object

参数解释

作业基本信息。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

receptors

Array of DockingReceptorDto objects

参数解释

受体文件列表。

约束限制

受体文件数量范围为[1-20]。

取值范围

不涉及

默认取值

不涉及

ligands

Array of LigandDto objects

参数解释

配体文件列表。

约束限制

配体文件数量固定为1。

取值范围

不涉及

默认取值

不涉及

engine

String

参数解释

分子对接引擎。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

job_result

JobResult object

参数解释

作业结果信息。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

part_failed_reason

Array of FailedReasonRecord objects

参数解释

部分失败原因和数量。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

cluster_result

ClusterJobRsp object

参数解释

聚类结果信息。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表4 DrugJobDto

参数

参数类型

描述

id

String

参数解释

作业ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

name

String

参数解释

作业的名称。

约束限制

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

取值范围

不涉及

默认取值

不涉及

eihealth_project_id

String

参数解释

作业所属空间ID。

约束限制

不涉及

取值范围

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

默认取值

不涉及

eihealth_project_name

String

参数解释

作业所属空间名称。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

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

参数解释

作业进度信息。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

upstream_job_info

String

参数解释

上游作业信息。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表5 Progress

参数

参数类型

描述

overall

Float

参数解释

整体进度。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

estimated_finish_time

Long

参数解释

预计结束时间,毫秒。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表6 DockingReceptorDto

参数

参数类型

描述

receptor

ReceptorDrugFile object

参数解释

受体文件。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

bounding_box

BoundingBoxDto object

参数解释

结合口袋,包含口袋中心位置和尺寸大小。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

remove_ion

Boolean

参数解释

去除受体中的离子。

约束限制

不涉及

取值范围

  • true:去除。

  • false:不去除。

默认取值

true

remove_water

Boolean

参数解释

去除受体中的水分子。

约束限制

不涉及

取值范围

  • true:去除。

  • false:不去除。

默认取值

true

remove_ligand

Boolean

参数解释

去除受体中的配体分子。

约束限制

不涉及

取值范围

  • true:去除。

  • false:不去除。

默认取值

true

add_hydrogen

Boolean

参数解释

增加氢原子。

约束限制

不涉及

取值范围

  • true:增加氢原子。

  • false:不增加氢原子。

默认取值

false

docking_type

String

参数解释

对接类型。

约束限制

不支持

取值范围

  • BLIND_DOCKING

  • POCKET_DOCKING

默认取值

POCKET_DOCKING

reference_file

ReferenceLigandFile object

参数解释

模板配体文件,仅引擎为SIMILAR_DOCKING时提供。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表7 ReceptorDrugFile

参数

参数类型

描述

source

String

参数解释

受体的数据源。

约束限制

不涉及

取值范围

  • EXTRANET:外部网络数据

  • PRIVATE:私有数据

  • PUBLIC:公共数据

  • RAW :源数据

默认取值

不涉及

url

String

参数解释

文件URL。

约束限制

当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。

取值范围

文件URL仅支持以.pdb格式结尾,长度为[1-2000]个字符。

默认取值

不涉及

format

String

参数解释

文件格式。

约束限制

仅数据源source为RAW时提供。

取值范围

  • PDB:PDB文件

默认取值

不涉及

data

String

参数解释

文件原始数据。

约束限制

仅数据源source为RAW时提供。

取值范围

长度为[0-10000000]个字符

默认取值

不涉及

表8 BoundingBoxDto

参数

参数类型

描述

center

Array of doubles

参数解释

口袋中心坐标,x、y、z 轴的坐标。

约束限制

坐标数量固定为3,坐标大小范围为[-9999999-99999999]。

取值范围

不涉及

默认取值

不涉及

size

Array of floats

参数解释

口袋尺寸大小,x、y、z轴的大小。

约束限制

数组元素数量固定为3,x、y、z轴的大小范围为[2-500]。

取值范围

不涉及

默认取值

不涉及

padding

Float

参数解释

填充。

约束限制

不涉及

取值范围

0-20

默认取值

不涉及

表9 ReferenceLigandFile

参数

参数类型

描述

source

String

参数解释

受体的数据源。

约束限制

不涉及

取值范围

  • EXTRANET:外部网络数据

  • PRIVATE:私有数据

  • PUBLIC:公共数据

  • RAW :源数据

默认取值

不涉及

url

String

参数解释

文件URL。

约束限制

当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。

取值范围

文件URL仅支持以.pdb、.sdf、.mol2、.smi、.csv结尾,长度为[1-2000]个字符。

默认取值

不涉及

format

String

参数解释

文件格式。

约束限制

仅数据源source为RAW时提供。

取值范围

  • PDB

  • SDF

  • MOL2

  • SMI

  • CSV

默认取值

不涉及

data

String

参数解释

文件原始数据。

约束限制

仅数据源source为RAW时提供。

取值范围

长度为[0-10000000]个字符。

默认取值

不涉及

表10 LigandDto

参数

参数类型

描述

ligand

DrugFile object

参数解释

配体文件。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

count

Integer

参数解释

计算个数。

约束限制

不涉及

取值范围

1-1000000

默认取值

不涉及

表11 DrugFile

参数

参数类型

描述

source

String

参数解释

受体的数据源。

约束限制

不涉及

取值范围

  • EXTRANET:外部网络数据

  • PRIVATE:私有数据

  • PUBLIC:公共数据

  • RAW :源数据

默认取值

不涉及

url

String

参数解释

文件URL。

约束限制

当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。

取值范围

文件URL仅支持以.pdb、.mol2、.sdf、.smi为结尾,长度为[1-2000]个字符。

默认取值

不涉及

format

String

参数解释

文件格式。

约束限制

仅数据源source为 RAW 时提供。

取值范围

  • PDB

  • SDF

  • MOL2

  • SMI

默认取值

不涉及

data

String

参数解释

文件原始数据。

约束限制

仅数据源source为RAW时提供。

取值范围

长度为[0-10000000]个字符。

默认取值

不涉及

表12 JobResult

参数

参数类型

描述

total_count

Integer

参数解释

输入总数。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

failed_count

Integer

参数解释

失败个数。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

sub_tasks_duration

Array of floats

参数解释

子任务运行时长(秒)。

约束限制

子任务数量范围为[1-30]。

取值范围

不涉及

默认取值

不涉及

num_molecules

Integer

参数解释

分子聚类任务中的分子总数。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

success_count

Integer

参数解释

聚类成功的分子数。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表13 ClusterJobRsp

参数

参数类型

描述

method

String

参数解释

分子聚类方法。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

output_dir

String

参数解释

分子聚类输出结果。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

status

String

参数解释

作业结果信息。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

failed_reasons

Array of FailedReasonRecord objects

参数解释

部分失败原因和数量。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表14 FailedReasonRecord

参数

参数类型

描述

reason

String

参数解释

失败原因。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

count

Integer

参数解释

失败数量。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求示例

查询分子对接作业详情。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/docking/{job_id}

响应示例

状态码:200

OK

{
  "basic_info" : {
    "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
    "name" : "demo-job",
    "labels" : [ "labelA", "labelB" ],
    "status" : "FINISHED",
    "type" : "OPTIMIZATION",
    "create_time" : "2021-01-30T02:34:36Z",
    "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
  },
  "receptors" : [ {
    "receptor" : {
      "source" : "PRIVATE",
      "url" : "project:/dir/file"
    },
    "bounding_box" : {
      "center" : [ 0, 0, 0 ],
      "size" : [ 10, 10, 10 ]
    },
    "remove_water" : true,
    "remove_ion" : false,
    "remove_ligand" : false
  } ],
  "ligands" : [ {
    "ligand" : {
      "source" : "PRIVATE",
      "url" : "project:/dir/file"
    },
    "count" : 100
  } ],
  "engine" : "AUTODOCK_VINA",
  "job_result" : {
    "total_count" : 10,
    "failed_count" : 1
  },
  "cluster_result" : {
    "method" : "hiq_mc",
    "output_dir" : "project://bucket/path/to/task/dir/",
    "status" : "finished",
    "failed_reasons" : [ {
      "reason" : "failed reason"
    }, {
      "count" : 1
    } ]
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档