文档首页/ AI科学计算服务/ API参考/ API/ 小分子药物设计/ CPI作业管理/ 创建CPI作业
更新时间：2025-07-08 GMT+08:00
查看PDF
分享

创建CPI作业

功能介绍

创建CPI作业。

URI

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

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

参数解释：

受体文件列表。

约束限制：

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

取值范围：

不涉及

默认取值：

不涉及

ligands

是

Array of MoleculeFileDto objects

参数解释：

小分子文件列表。

约束限制：

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

取值范围：

不涉及

默认取值：

不涉及
表4 CreateDrugJobBasicInfo

参数

是否必选

参数类型

描述

name

是

String

参数解释：

作业名称。

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

labels

否

Array of strings

参数解释：

标签。

约束限制：

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

取值范围：

不涉及

默认取值：

不涉及

upstream_job_info

否

String

参数解释：

上游作业信息。

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及
表5 CpiReceptor

参数

是否必选

参数类型

描述

source

是

String

参数解释：

受体的数据源。

约束限制：

不涉及

取值范围：

  • EXTRANET：外部网络数据

  • PRIVATE：私有数据

  • PUBLIC：公共数据

  • RAW ：源数据

默认取值：

不涉及

url

否

String

参数解释：

文件URL。

约束限制：

当数据源source为外部网络数据时为https地址，为用户私有数据中心时为空间路径，为公共数据场景时为obs地址。

取值范围：

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

默认取值：

不涉及

format

否

String

参数解释：

文件格式。

约束限制：

仅数据源source为RAW时提供。

取值范围：

  • FASTA：FASTA文件格式

默认取值：

不涉及

data

否

String

参数解释：

文件原始数据。

约束限制：

仅数据源source为RAW时提供。

取值范围：

长度为[0-10000000]个字符。

默认取值：

不涉及

fasta_count

否

Integer

参数解释：

fasta文件中氨基酸数量。

约束限制：

不涉及

取值范围：

1-100

默认取值：

不涉及
表6 MoleculeFileDto

参数

是否必选

参数类型

描述

file

是

MoleculeFile object

参数解释：

分子文件。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

count

是

Integer

参数解释：

分子个数。

约束限制：

不涉及

取值范围：

1-1000000

默认取值：

不涉及
表7 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时提供。

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：201

表8 响应Body参数

参数

参数类型

描述

id

String

参数解释：

作业ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

limit_concurrency

Integer

参数解释：

限制的并发量。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求示例

创建CPI作业，作业名称为demo-job， 受体文件为project:/dir/file， 配体文件为project:/dir/file。

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

{
  "basic_info" : {
    "name" : "demo-job",
    "labels" : [ "labelA" ]
  },
  "receptors" : [ {
    "source" : "PRIVATE",
    "url" : "project:/dir/file"
  } ],
  "ligands" : [ {
    "file" : {
      "source" : "PRIVATE",
      "url" : "project:/dir/file"
    },
    "count" : 10000
  } ]
}

响应示例

状态码：201

CREATED

  • 创建CPI作业成功。

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

  • 创建CPI作业成功，当前运行作业数已达配额限制，此作业会等待。

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

状态码

状态码

描述

201

CREATED

错误码

请参见错误码。

父主题： CPI作业管理

相关文档