创建分子对接作业
功能介绍
创建分子对接作业。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/docking
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 |
|
eihealth_project_id |
是 |
String |
平台项目ID。 最小长度：1 最大长度：128 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
basic_info |
是 |
CreateDrugJobBasicInfo object |
创建药物作业基本信息。 |
|
receptors |
是 |
Array of DockingReceptorDto objects |
受体文件列表。 数组长度：1 - 20 |
|
ligands |
是 |
Array of LigandDto objects |
配体文件列表，当前仅支持1个。 数组长度：1 - 1 |
|
engine |
否 |
String |
引擎，支持DSDP、AUTODOCK_VINA、SIMILAR_DOCKING。 缺省值：AUTODOCK_VINA 最小长度：0 最大长度：15 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
作业的名称，取值范围：[5,64]，允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度：5 最大长度：64 |
|
labels |
否 |
Array of strings |
标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。 最小长度：1 最大长度：32 数组长度：0 - 5 |
|
upstream_job_info |
否 |
String |
上游作业信息。 最小长度：1 最大长度：10240 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
receptor |
是 |
ReceptorDrugFile object |
受体文件。 |
|
bounding_box |
是 |
BoundingBoxDto object |
结合口袋，包含口袋中心位置和尺寸大小。 |
|
remove_ion |
否 |
Boolean |
去除受体中的离子。 缺省值：true |
|
remove_water |
否 |
Boolean |
去除受体中的水分子。 缺省值：true |
|
remove_ligand |
否 |
Boolean |
去除受体中的配体分子。 缺省值：true |
|
add_hydrogen |
否 |
Boolean |
增加氢原子。 缺省值：false |
|
docking_type |
否 |
String |
对接类型，支持BLIND_DOCKING、POCKET_DOCKING。 缺省值：POCKET_DOCKING 最小长度：0 最大长度：15 |
|
reference_file |
否 |
ReferenceLigandFile object |
模板配体文件，仅引擎为SIMILAR_DOCKING时提供。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
source |
是 |
String |
受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值：
|
|
url |
否 |
String |
文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：1 最大长度：2000 |
|
format |
否 |
String |
文件格式，仅支持PDB，仅数据源为RAW时提供。 最小长度：1 最大长度：6 |
|
data |
否 |
String |
文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
source |
是 |
String |
受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值：
|
|
url |
否 |
String |
文件URL，当数据源为外部网络数据时为https地址，为用户私有数据中心时为项目路径，为公共数据场景时为obs地址。 最小长度：1 最大长度：2000 |
|
format |
否 |
String |
文件格式，支持PDB、SDF、MOL2、SMI、CSV等，仅数据源为RAW时提供。 最小长度：1 最大长度：6 |
|
data |
否 |
String |
文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
source |
是 |
String |
受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值：
|
|
url |
否 |
String |
文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：1 最大长度：2000 |
|
format |
否 |
String |
文件格式，支持PDB、SDF、MOL2、SMI，仅数据源为RAW时提供。 最小长度：1 最大长度：6 |
|
data |
否 |
String |
文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000 |
响应参数
状态码： 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
错误码
请参见错误码。
