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

查询自由能微扰作业详情 - ShowFepJob

功能介绍

查询自由能微扰作业详情。

授权信息

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

eihealth_project_id

是

String

参数解释:

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

ReceptorDrugFile object

受体文件。

add_membrane

Boolean

参数解释:

是否加膜处理。

约束限制:

不涉及

取值范围:

  • true:加膜

  • false:不加膜

默认取值:

false

ligands

Array of LigandPreviewDto objects

参数解释:

配体列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

graph

FepGraphDto object

参数解释:

路径图。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

params

FepParamDto object

参数解释:

FEP设置参数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

job_result

JobResult object

参数解释:

作业结果信息。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

part_failed_reason

Array of FailedReasonRecord objects

参数解释:

部分失败原因和数量。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

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

参数解释:

上游作业信息。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 Progress

参数

参数类型

描述

overall

Float

参数解释:

整体进度。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

estimated_finish_time

Long

参数解释:

预计结束时间,毫秒。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

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

参数

参数类型

描述

index

Integer

参数解释:

配体索引(从0起编号)。

约束限制:

不涉及

取值范围:

0-99

默认取值:

不涉及

file

DrugFile object

参数解释:

配体文件。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

配体名称,如果无名称则自动命名,格式为UNK+索引(从1起编号)。

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

smiles

String

参数解释:

分子SMILES表达式。

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

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

默认取值:

不涉及

表9 FepGraphDto

参数

参数类型

描述

center_id

String

参数解释:

中心配体名称。

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

pairs

Array of SimilarityDto objects

参数解释:

配体对列表。

约束限制:

配体长度为[1-100]。

取值范围:

不涉及

默认取值:

不涉及

表10 SimilarityDto

参数

参数类型

描述

ligand_ids

Array of strings

参数解释:

配体对。

约束限制:

配体固定数量为2,配体长度为[1-32]个字符。

取值范围:

不涉及

默认取值:

不涉及

表11 FepParamDto

参数

参数类型

描述

pre_equilibrium_time

Float

参数解释:

预平衡时长。

约束限制:

不涉及

取值范围:

范围为(0,200],单位为ps。

默认取值:

100

equilibrium_time

Float

参数解释:

平衡时长。

约束限制:

不涉及

取值范围:

范围为(0,10],单位为ns。

默认取值:

1

num_pre_equilibrium_steps

Integer

参数解释:

预平衡步数。

约束限制:

不涉及

取值范围:

1-200000

默认取值:

50000

num_equilibrium_steps

Integer

参数解释:

平衡步数。

约束限制:

不涉及

取值范围:

1-10000000

默认取值:

500000

timestep_size

Double

参数解释:

时间步长,单位ps。

约束限制:

不涉及

取值范围:

0.001-0.004。

默认取值:

0.002

num_lambda

Integer

参数解释:

lambda个数。

约束限制:

不涉及

取值范围:

2-30。

默认取值:

20

表12 JobResult

参数

参数类型

描述

total_count

Integer

参数解释:

输入总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

failed_count

Integer

参数解释:

失败个数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sub_tasks_duration

Array of floats

参数解释:

子任务运行时长(秒)。

约束限制:

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

取值范围:

不涉及

默认取值:

不涉及

num_molecules

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

success_count

Integer

参数解释:

聚类成功的分子数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表13 FailedReasonRecord

参数

参数类型

描述

reason

String

参数解释:

失败原因。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

count

Integer

参数解释:

失败数量。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

查询自由能微扰作业详情。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/fep/{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
  },
  "receptor" : {
    "source" : "PRIVATE",
    "url" : "project:/dir/file"
  },
  "ligands" : [ {
    "name" : "GLY:A:514",
    "smiles" : "C1CCCCC1",
    "index" : 0,
    "file" : {
      "source" : "RAW",
      "format" : "PDB",
      "data" : "MODEL1.xxxxxxx.END"
    }
  }, {
    "name" : "UNK1",
    "smiles" : "c1ccccc1",
    "index" : 0,
    "file" : {
      "source" : "PRIVATE",
      "url" : "project:/dir/file"
    }
  } ],
  "graph" : {
    "center_id" : "GLY:A:514",
    "pairs" : [ {
      "ligand_ids" : [ "GLY:A:514", "DrugBank:UNK1" ]
    } ]
  },
  "params" : {
    "num_pre_equilibrium_steps" : 50000,
    "num_equilibrium_steps" : 500000,
    "timestep_size" : 0.002,
    "num_lambda" : 20
  },
  "job_result" : {
    "total_count" : 10,
    "failed_count" : 1
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档