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

创建分子对接作业

功能介绍

创建分子对接作业。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

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

默认取值

不涉及

eihealth_project_id

String

参数解释

空间ID。

约束限制

不涉及

取值范围

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

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

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

约束限制

不涉及

取值范围

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

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

basic_info

CreateDrugJobBasicInfo object

参数解释

创建药物作业基本信息。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

receptors

Array of DockingReceptorDto objects

参数解释

受体文件列表。

约束限制

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

取值范围

不涉及

默认取值

不涉及

ligands

Array of LigandDto objects

参数解释

配体文件列表。

约束限制

配体文件数量固定为 1。

取值范围

不涉及

默认取值

不涉及

engine

String

参数解释

引擎。

约束限制

不涉及

取值范围

  • DSDP

  • SIMILAR_DOCKING

  • AUTODOCK_VINA

默认取值

AUTODOCK_VINA

表4 CreateDrugJobBasicInfo

参数

是否必选

参数类型

描述

name

String

参数解释

作业名称。

约束限制

不涉及

取值范围

长度范围[5-64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。

默认取值

不涉及

labels

Array of strings

参数解释

标签。

约束限制

标签数量范围为[0-5],单个标签长度为[1-32]个字符,支持中文、字母、数字、空格、下划线(_)和中划线(-),且不能以空格开头或结尾。

取值范围

不涉及

默认取值

不涉及

upstream_job_info

String

参数解释

上游作业信息。

约束限制

不涉及

取值范围

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

默认取值

不涉及

表5 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时提供。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表6 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]个字符

默认取值

不涉及

表7 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

默认取值

不涉及

表8 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]个字符。

默认取值

不涉及

表9 LigandDto

参数

是否必选

参数类型

描述

ligand

DrugFile object

参数解释

配体文件。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

count

Integer

参数解释

计算个数。

约束限制

不涉及

取值范围

1-1000000

默认取值

不涉及

表10 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]个字符。

默认取值

不涉及

响应参数

状态码:201

表11 响应Body参数

参数

参数类型

描述

id

String

参数解释

作业ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

limit_concurrency

Integer

参数解释

限制的并发量。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求示例

创建分子对接作业,作业名称为demo-job, 受体文件为project:/dir/file,口袋中心位置的值为[0,0,0],口袋尺寸大小为[10,10,10],去除受体的水分子。

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

{
  "basic_info" : {
    "name" : "demo-job",
    "labels" : [ "labelA" ]
  },
  "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
  } ]
}

响应示例

状态码:201

CREATED

  • 创建分子对接作业成功。

    {
      "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1"
    }
  • 创建分子对接作业成功,当前运行作业数已达配额限制,此作业会等待。

    {
      "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
      "limit_concurrency" : 50
    }

状态码

状态码

描述

201

CREATED

错误码

请参见错误码

相关文档