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

查询靶点口袋分子设计作业详情

功能介绍

查询靶点口袋分子设计作业详情。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-mol-design/{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

作业基本信息。

receptor

PocketMolDesignReceptorDto object

靶点文件。

ligands

Array of PocketFragment objects

配体文件列表。

数组长度:1 - 1

num_trials

Integer

生成分子数量。

最小值:1

最大值:5000

缺省值:1000

model_list

Array of BasicDrugModel objects

模型列表。

molecular_weight

Array of integers

分子量范围。

最小值:1

最大值:1000

数组长度:2 - 2

optimization_mode

String

优化类型。

枚举值:

  • generation
  • side_chains_decoration
  • scaffold_hopping
  • fragment_growing

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 PocketMolDesignReceptorDto

参数

参数类型

描述

file

ReceptorDrugFile object

靶点文件。

bounding_box

BoundingBoxDto object

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

remove_ion

Boolean

去除受体中的离子。

缺省值:true

remove_water

Boolean

去除受体中的水分子。

缺省值:true

remove_ligand

Boolean

去除受体中的配体分子。

缺省值:true

add_hydrogen

Boolean

增加氢原子。

缺省值:false

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

参数

参数类型

描述

source

String

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

枚举值:

  • EXTRANET
  • PRIVATE
  • PUBLIC
  • RAW

url

String

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

最小长度:1

最大长度:2000

format

String

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

最小长度:1

最大长度:6

name

String

原始配体名称,仅RAW类型时用于配体名称标识。

最小长度:1

最大长度:128

data

String

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

最小长度:0

最大长度:10000000

edited

EditedLigand object

编辑后的配体。

label_sites

LabelSite object

标记位点。

表10 EditedLigand

参数

参数类型

描述

source

String

文件来源,仅支持RAW。

最小长度:1

最大长度:6

format

String

文件格式,仅支持CIF。

最小长度:1

最大长度:6

data

String

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

最小长度:0

最大长度:10000000

表11 LabelSite

参数

参数类型

描述

index

Array of integers

索引。

最小值:0

最大值:99999

数组长度:0 - 50

name

Array of strings

标记位点名称。

最小长度:1

最大长度:128

数组长度:0 - 50

coordinate

Array<Array<Number>>

位点三维坐标集。

数组长度:0 - 50

表12 BasicDrugModel

参数

参数类型

描述

id

String

模型ID。

task_id

String

任务ID。

name

String

模型名称。

creator

String

模型创建者。

type

String

模型类型。

value_range

ValueRange object

区间上下限,仅回归型存在。

description

String

模型描述信息。

表13 ValueRange

参数

参数类型

描述

lower

Float

区间下限,仅回归型存在。

upper

Float

区间上限,仅回归型存在。

表14 ClusterJobRsp

参数

参数类型

描述

method

String

分子聚类方法。

output_dir

String

分子聚类输出结果。

status

String

作业结果信息。

failed_reasons

Array of FailedReasonRecord objects

部分失败原因和数量。

表15 FailedReasonRecord

参数

参数类型

描述

reason

String

失败原因。

count

Integer

失败数量。

请求示例

响应示例

状态码: 200

OK

{
  "basic_info" : {
    "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
    "name" : "demo-job",
    "labels" : [ "labelA", "labelB" ],
    "status" : "FINISHED",
    "type" : "POCKE_MOL_DESIGN",
    "start_time" : "2021-01-30T02:34:36Z",
    "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
  },
  "receptor" : {
    "file" : {
      "source" : "PRIVATE",
      "url" : "project:/dir/file"
    }
  },
  "ligands" : [ {
    "source" : "PRIVATE"
  }, {
    "url" : "project:/dir/file"
  } ],
  "cluster_result" : {
    "method" : "hiq_mc",
    "output_dir" : "project://bucket/path/to/task/dir/",
    "status" : "finished",
    "failed_reasons" : [ {
      "reason" : "failed reason"
    }, {
      "count" : 1
    } ]
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档