文档首页/ 医疗智能体/ API参考/ API（盘古辅助制药平台）/ 分子对接作业管理/ 查询分子对接作业详情
更新时间：2024-12-13 GMT+08:00
查看PDF
分享

查询分子对接作业详情

功能介绍

查询分子对接作业详情。

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个。

数组长度：1 - 1

engine

String

引擎，支持DSDP、AUTODOCK_VINA、SIMILAR_DOCKING。

job_result

JobResult object

作业结果信息。

part_failed_reason

Array of FailedReasonRecord objects

部分失败原因和数量。

cluster_result

ClusterJobRsp object

聚类结果信息。
表4 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

作业进度信息。

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

remove_water

Boolean

去除受体中的水分子。

缺省值：true

remove_ligand

Boolean

去除受体中的配体分子。

缺省值：true

add_hydrogen

Boolean

增加氢原子。

缺省值：false

docking_type

String

对接类型，支持BLIND_DOCKING、POCKET_DOCKING。

缺省值：POCKET_DOCKING

最小长度：0

最大长度：15

reference_file

ReferenceLigandFile object

模板配体文件，仅引擎为SIMILAR_DOCKING时提供。
表7 ReceptorDrugFile

参数

参数类型

描述

source

String

受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。

枚举值：

  • EXTRANET
  • PRIVATE
  • PUBLIC
  • RAW

url

String

文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。

最小长度：1

最大长度：2000

format

String

文件格式，仅支持PDB，仅数据源为RAW时提供。

最小长度：1

最大长度：6

data

String

文件原始数据，仅数据源为RAW时提供。

最小长度：0

最大长度：10000000
表8 BoundingBoxDto

参数

参数类型

描述

center

Array of floats

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

最小值：-9999999

最大值：99999999

数组长度：3 - 3

size

Array of floats

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

最小值：2

最大值：500

数组长度：3 - 3

padding

Float

填充。

最小值：0

最大值：20
表9 ReferenceLigandFile

参数

参数类型

描述

source

String

受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）

枚举值：

  • EXTRANET
  • PRIVATE
  • PUBLIC
  • RAW

url

String

文件URL，当数据源为外部网络数据时为https地址，为用户私有数据中心时为项目路径，为公共数据场景时为obs地址。

最小长度：1

最大长度：2000

format

String

文件格式，支持PDB、SDF、MOL2、SMI、CSV等，仅数据源为RAW时提供。

最小长度：1

最大长度：6

data

String

文件原始数据，仅数据源为RAW时提供。

最小长度：0

最大长度：10000000
表10 LigandDto

参数

参数类型

描述

ligand

DrugFile object

配体文件。

count

Integer

计算个数。

最小值：1

最大值：1000000
表11 DrugFile

参数

参数类型

描述

source

String

受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。

枚举值：

  • EXTRANET
  • PRIVATE
  • PUBLIC
  • RAW

url

String

文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。

最小长度：1

最大长度：2000

format

String

文件格式，支持PDB、SDF、MOL2、SMI，仅数据源为RAW时提供。

最小长度：1

最大长度：6

data

String

文件原始数据，仅数据源为RAW时提供。

最小长度：0

最大长度：10000000
表12 JobResult

参数

参数类型

描述

total_count

Integer

输入总数。

failed_count

Integer

失败个数。
表13 ClusterJobRsp

参数

参数类型

描述

method

String

分子聚类方法。

output_dir

String

分子聚类输出结果。

status

String

作业结果信息。

failed_reasons

Array of FailedReasonRecord objects

部分失败原因和数量。
表14 FailedReasonRecord

参数

参数类型

描述

reason

String

失败原因。

count

Integer

失败数量。

请求示例

无

响应示例

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

错误码

请参见错误码。

相关文档