创建靶点优化作业 - CreateTargetOptJob
功能介绍
创建靶点优化作业。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/target-optimization
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
basic_info | 是 | CreateDrugJobBasicInfo object | 参数解释: 创建药物作业基本信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
receptor | 是 | TargetOptReceptor object | 参数解释: 受体文件。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
ligand | 否 | TargetOptLigand object | 参数解释: 配体文件。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
md_params | 否 | MdParam object | 参数解释: MD参数配置。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 是 | String | 参数解释: 作业名称。 约束限制: 不涉及 取值范围: 长度范围[5-64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 默认取值: 不涉及 |
labels | 否 | Array of strings | 参数解释: 标签。 约束限制: 标签数量范围为[0-5],单个标签长度为[1-32]个字符,支持中文、字母、数字、空格、下划线(_)和中划线(-),且不能以空格开头或结尾。 取值范围: 不涉及 默认取值: 不涉及 |
upstream_job_info | 否 | String | 参数解释: 上游作业信息。 约束限制: 不涉及 取值范围: 长度为[1-10240]个字符。 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
file | 是 | ReceptorDrugFile object | 受体文件。 |
balanced_charge | 否 | Boolean | 参数解释: 是否平衡电荷。 约束限制: 不涉及 取值范围:
默认取值: true |
water_model | 否 | String | 参数解释: 水模型。 约束限制: 不涉及 取值范围:
默认取值: tip3p |
force_field | 否 | String | 参数解释: 蛋白立场。 约束限制: 不涉及 取值范围:
默认取值: amber99sb |
ion_type | 否 | String | 参数解释: 离子种类。 约束限制: 如果设置了平衡电荷不支持选择None。 取值范围:
默认取值: NaCl |
ion_concentration | 否 | Float | 参数解释: 离子浓度,单位 mol/L。 约束限制: 如果离子种类设置为None,离子浓度不支持设置。 取值范围: 0-5.0 默认取值: 0.15 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
source | 是 | String | 参数解释: 受体的数据源。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
url | 否 | String | 参数解释: 文件URL。 约束限制: 当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。 取值范围: 文件URL仅支持以.pdb格式结尾,长度为[1-2000]个字符。 默认取值: 不涉及 |
format | 否 | String | 参数解释: 文件格式。 约束限制: 仅数据源source为RAW时提供。 取值范围:
默认取值: 不涉及 |
data | 否 | String | 参数解释: 文件原始数据。 约束限制: 仅数据源source为RAW时提供。 取值范围: 长度为[0-10000000]个字符 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
file | 是 | ProbeDrugFile object | 配体文件。 |
force_field | 否 | String | 参数解释: 配体力场,支持选择gaff、gaff2。 约束限制: 取值范围:
默认取值: gaff |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
source | 是 | String | 参数解释: 受体的数据源。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
url | 否 | String | 参数解释: 文件URL。 约束限制: 当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。 取值范围: 文件URL仅支持以.pdb、.mol2、.sdf为结尾,长度为[1-2000]个字符。 默认取值: 不涉及 |
format | 否 | String | 参数解释: 文件格式。 约束限制: 仅数据源source为RAW时提供。 取值范围:
默认取值: 不涉及 |
data | 否 | String | 参数解释: 文件原始数据。 约束限制: 仅数据源source为RAW时提供。 取值范围: 长度为[0-10000000]个字符。 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
timestep_size | 否 | Float | 参数解释: MD模拟的时间步长,单位fs。 约束限制: 不涉及 取值范围: 0-5.0 默认取值: 2 |
temperature | 否 | Float | 参数解释: MD模拟的温度,单位K。 约束限制: 不涉及 取值范围: 0-1000.0 默认取值: 300 |
step_params | 否 | MdStepParam object | 参数解释: 计算步骤参数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:201
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 作业ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
limit_concurrency | Integer | 参数解释: 限制的并发量。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
创建靶点优化作业,作业名称为demo-job,受体文件为project:/dir/file,配体文件为project:/dir/file,时间步长为2fs,温度为300k,能量最小化步数为10000,nvt为200ps,npt为500ps,平衡步骤模拟时长为50ns。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/target-optimization
{
"basic_info" : {
"name" : "demo-job",
"labels" : [ "labelA" ]
},
"receptor" : {
"file" : {
"source" : "PRIVATE",
"url" : "project:/dir/file"
},
"balanced_charge" : true,
"water_model" : "tip3p",
"force_field" : "amber99sb",
"ion_type" : "NaCl",
"ion_concentration" : 0.15
},
"ligand" : {
"file" : {
"source" : "PRIVATE",
"url" : "project:/dir/file"
},
"force_field" : "gaff"
},
"md_params" : {
"timestep_size" : 2,
"temperature" : 300,
"step_params" : {
"energy_minimization_steps" : 10000,
"nvt" : 200,
"npt" : 500,
"simulation_time" : 50
}
}
} 响应示例
状态码:201
CREATED
创建靶点优化作业成功。
{ "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" }创建靶点优化作业成功,当前运行作业数已达配额限制,此作业会等待。
{ "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }
状态码
状态码 | 描述 |
|---|---|
201 | CREATED |
错误码
请参见错误码。

