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

查询CPI作业详情

功能介绍

查询CPI作业详情。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/cpi/{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 ReceptorDrugFile objects

参数解释

受体文件列表。

约束限制

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

取值范围

不涉及

默认取值

不涉及

ligands

Array of MoleculeFileDto objects

参数解释

小分子文件列表。

约束限制

小分子文件数量固定为1。

取值范围

不涉及

默认取值

不涉及

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

参数

参数类型

描述

file

MoleculeFile object

参数解释

分子文件。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

count

Integer

参数解释

分子个数。

约束限制

不涉及

取值范围

1-1000000

默认取值

不涉及

表8 MoleculeFile

参数

参数类型

描述

source

String

参数解释

文件来源。

约束限制

长度为1到8,支持用户私有数据中心、公共数据和源数据。

取值范围

  • PRIVATE:用户私有数据。

  • PUBLIC:公共数据。

  • RAW:源数据。

默认取值

不涉及

url

String

参数解释

文件URL。

约束限制

不涉及

取值范围

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

默认取值

不涉及

format

String

参数解释

文件格式。

约束限制

仅数据源source为RAW时提供。

取值范围

  • PDB

  • SDF

  • MOL2

  • SMI

默认取值

不涉及

data

String

参数解释

文件原始数据。

约束限制

仅数据源source为RAW时提供。

取值范围

不涉及

默认取值

不涉及

请求示例

查询CPI作业详情。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/cpi/{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" : [ {
    "source" : "PRIVATE",
    "url" : "project:/dir/file"
  } ],
  "ligands" : [ {
    "file" : {
      "source" : "PRIVATE",
      "url" : "project:/dir/file"
    },
    "count" : 10000
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档