华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 作业基本信息。 receptor 是 ReceptorDrugFile object 受体文件。 ligand 是 ProbeDrugFile object 探针文件。 params 否 PocketDetectionParamDto object 靶点口袋发现设置参数。 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称,取值范围:[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度:5 最大长度:64 labels 否 Array of strings 标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5 表5 ReceptorDrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源:外部网络数据(如R CS B在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format 否 String 文件格式,仅支持PDB,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data 否 String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表6 ProbeDrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format 否 String 文件格式,支持PDB、SDF、MOL2,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data 否 String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表7 PocketDetectionParamDto 参数 是否必选 参数类型 描述 timestep_size 否 Double 时间步长,单位ps。 最小值:0.001 最大值:0.002 缺省值:0.002 num_minimization_steps 否 Integer 最小化步数。 最小值:5000 最大值:50000 缺省值:20000 pre_equilibrium_time 否 Integer 预平衡时长,单位ps。 最小值:20 最大值:200 缺省值:100 pocket_detection_time 否 Integer 口袋发现时长,单位ns。 最小值:20 最大值:50 缺省值:50 num_surface_points 否 Integer 表面原子离散点数量。 最小值:10 最大值:50 缺省值:20 probe_radius 否 Double 探针半径,单位A。 最小值:1.4 最大值:5 缺省值:1.4
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-detection 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "jobs" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "description" : "description", "priority" : 0, "timeout" : 1440, "output_dir" : "/job", "status" : "SUCCEEDED", "create_time" : "2021-01-30T02:34:36Z", "finish_time" : "2021-01-30T02:53:26Z", "user_name" : "gwj-test-01", "tool_info" : { "tool_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "tool_name" : "demo-workflow", "tool_version" : "1.0.0", "tool_type" : "workflow" }, "still_running_tasks" : [ "task1", "task2" ] } ], "count" : 1 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of JobListDto objects 作业列表 count Integer 作业总数 表5 JobListDto 参数 参数类型 描述 id String 作业id name String 作业的名称,取值范围:[1,63],允许大小写字母、数字、以及特殊字符中划线(-) description String 作业的描述,取值范围:输入字符最大长度为255 labels Array of strings 作业标签 priority Integer 作业优先级,[0,9],0表示最低,默认0 timeout Integer 作业执行超时时长,取值范围: [1, 144000],单位:分钟,默认数值1440 最小值:1 最大值:144000 output_dir String job结果存储目录,不指定则在workflow的工作目录下生产job同名子目录,指定则已指定路径为准 status String 作业状态 create_time String 作业创建时间 finish_time String 作业结束时间 failed_message String 失败提示,当作业执行失败时会返回 failed_reason String 失败原因,当作业执行失败时会返回 user_name String 创建任务的用户名称 tool_info ToolInfoDto object 作业依赖的组件信息 io_acc_id String 作业使用的IO加速实例id,不填表示不使用; io_acc_expected_usage Integer 作业使用的SFS-Turbo实例预期占用存储量,单位G,用于投递作业时评估当前加速实例余量是否充足 still_running_tasks Array of strings 仍在运行中的子任务 表6 ToolInfoDto 参数 参数类型 描述 tool_id String 作业依赖的组件id tool_name String 作业依赖的组件名称 tool_version String 作业依赖的组件版本 tool_type String 作业依赖的组件类型,取值范围app|workflow
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 end_time 否 Long 最大开始时间 job_name 否 String 作业名称 取值范围:长度为[1,63],以小写字母开头,允许出现中划线(-)、小写字母和数字,且必须以小写字母或数字结尾。 最小长度:1 最大长度:128 labels 否 Array 标签列表 最小长度:1 最大长度:32 数组长度:0 - 5 limit 否 Integer 限制量,单次查询总量,必须由数字组成,默认为100,取值范围[1,1000] 最小值:1 最大值:1000 缺省值:100 offset 否 Integer 偏移量,查询起始偏移,必须由数字组成,默认为0,取值范围[0,100000000] 最小值:0 最大值:100000000 缺省值:0 sort_dir 否 String 排序规则 目前默认时间降序 缺省值:DESC sort_key 否 String 排序规则 目前默认时间降序,支持根据status start_time 否 Long 最小开始时间 status 否 String 作业运行状态 取值(Succeeded|Running|Pending|Failed|Cancelling|Cancelled|Unknown) tool_name 否 String 作业依赖的组件名称(有可能是Workflow,有可能是app), 取值范围:长度为[1,56],以小写字母开头,允许出现中划线(-)、小写字母和数字,且必须以小写字母或数字结尾。 最小长度:1 最大长度:128 user_name 否 String 作业创建者 最小长度:1 最大长度:128 finish_start_time 否 Long 最小结束时间 finish_end_time 否 Long 最大结束时间
  • 请求示例 创建分子优化作业,作业名称为demo-job,分子SMILES表达式为string,靶点设置的受体文件为project:/test.pdb,口袋中心位置为[0,0,0],口袋尺寸大小为[500,500,500],设置弱约束为eye_corrosion,类型为布尔值,值为true,设置强约束为sascore,类型为range,值为[0,1]。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/optimization { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "smiles" : "string", "num_trials" : 500, "binding_sites" : [{ "name" : "target1", "receptor" : { "source" : "PRIVATE", "url" : "project:/test.pdb" }, "bounding_box" : { "center" : [ 0, 0, 0 ], "size" : [ 500, 500, 500 ] }, "remove_ion" : false, "remove_water" : false, "remove_ligand" : false }], "weak_constraints" : [ { "name" : "eye_corrosion", "type" : "bool", "bool" : true } ], "strong_constraints" : [ { "name" : "sascore", "type" : "range", "range" : [ 0, 1 ] } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 创建药物作业基本信息。 smiles 否 String 分子SMILES表达式。 最小长度:1 最大长度:512 molecule_file 否 DrugFile object 分子文件。 binding_site 否 BindSiteDto object 受体。 binding_sites 否 Array of BindSiteDto objects 受体列表和受体是二选一的关系,受体列表优先级最高。 数组长度:0 - 2 weak_constraints 否 Array of WeakConstraintDto objects 弱约束集合。 数组长度:0 - 10 strong_constraints 否 Array of StrongConstraintDto objects 强约束集合。 数组长度:0 - 5 sampler_mixin_weight 否 Float 初始化采样权重,参数范围(0.5, 1),不包含0.5和1,默认为0.6。 最小值:0.5 最大值:1 缺省值:0.6 base_model_id 否 String 基模型id。 缺省值:pangu-drug-model 最小长度:0 最大长度:128 model_ids 否 Array of strings 模型id列表。 最小长度:1 最大长度:128 数组长度:0 - 10 num_trials 否 Integer 生成分子数量。 最小值:0 最大值:5000 缺省值:5000 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称,取值范围:[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度:5 最大长度:64 labels 否 Array of strings 标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5 表5 DrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format 否 String 文件格式,支持PDB、SDF、MOL2、SMI,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data 否 String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表6 BindSiteDto 参数 是否必选 参数类型 描述 name 否 String 靶点名称,只能设置为target1或者target2。 最小长度:1 最大长度:128 receptor 是 ReceptorDrugFile object 受体文件。 bounding_box 否 BoundingBoxDto object 结合口袋,包含口袋中心位置和尺寸大小。 remove_ion 否 Boolean 去除受体中的离子。 缺省值:true remove_water 否 Boolean 去除受体中的水分子。 缺省值:true remove_ligand 否 Boolean 去除受体中的配体分子。 缺省值:true add_hydrogen 否 Boolean 增加氢原子。 缺省值:false 表7 ReceptorDrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format 否 String 文件格式,仅支持PDB,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data 否 String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表8 BoundingBoxDto 参数 是否必选 参数类型 描述 center 是 Array of doubles 口袋中心坐标; x, y, z轴的坐标。 最小值:-9999999 最大值:99999999 数组长度:3 - 3 size 是 Array of floats 口袋尺寸大小; x, y, z轴的大小。 最小值:2 最大值:500 数组长度:3 - 3 padding 否 Float 填充。 最小值:0 最大值:20 表9 WeakConstraintDto 参数 是否必选 参数类型 描述 id 否 String 自定义模型id,仅弱约束为模型时填写。 最小长度:1 最大长度:128 name 否 String 属性名称。 最小长度:1 最大长度:128 type 是 String 属性约束类型。 枚举值: bool range struct minimize maximize interaction bool 否 Boolean 属性约束类型bool的参数。 range 否 Array of floats 属性约束类型range的参数。 最小值:-9999 最大值:9999 数组长度:2 - 2 struct 否 StructureConstraintParamsDto object 结构约束参数。 quantiles 否 Array of floats 属性约束类型minimize和maximize的参数。 最小值:0.0 最大值:1.0 数组长度:2 - 2 interaction 否 InteractionConstraintDto object 相互作用力约束参数。 表10 StrongConstraintDto 参数 是否必选 参数类型 描述 id 否 String 自定义模型id,仅强约束为模型时填写。 最小长度:1 最大长度:128 name 否 String 属性名称。 最小长度:1 最大长度:128 type 是 String 属性约束类型。 枚举值: bool range struct interaction bool 否 Boolean 属性约束类型bool的参数。 range 否 Array of floats 属性约束类型range的参数。 最小值:-9999 最大值:9999 数组长度:2 - 2 struct 否 StructureConstraintParamsDto object 结构约束参数。 interaction 否 InteractionConstraintDto object 相互作用力约束参数。 表11 StructureConstraintParamsDto 参数 是否必选 参数类型 描述 structs 是 Array of strings 子结构SMILES。 最小长度:1 最大长度:120 数组长度:1 - 8 exclusive 是 Boolean 是否排除子结构。 operator 否 String 多个子结构之间的逻辑关系。 枚举值: or and 表12 InteractionConstraintDto 参数 是否必选 参数类型 描述 interactions 是 Array of Interaction objects 相互作用力列表。 数组长度:1 - 8 exclusive 是 Boolean 是否排除指定的约束作用力。 operator 否 String 多个作用力之间的逻辑关系。 枚举值: or and 表13 Interaction 参数 是否必选 参数类型 描述 binding_site 是 String 靶点,只支持target1或target2。 最小长度:1 最大长度:128 type 是 String 相互作用力类型:氢键、疏水作用、盐桥、π-π堆积、π-阳离子。 枚举值: hydrogen_bond hydrophobic_action salt_bridge pi_stacking pi_cation amino_acid 是 String 氨基酸。 最小长度:4 最大长度:16
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/optimization 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128
  • 响应示例 状态码: 201 CREATED 创建靶点优化作业成功。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" } 创建靶点优化作业成功,当前运行作业数已达配额限制,此作业会等待。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }
  • 请求示例 创建靶点优化作业,作业名称为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 } } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 创建药物作业基本信息。 receptor 是 TargetOptReceptor object 受体文件。 ligand 否 TargetOptLigand object 配体文件。 md_params 否 MdParam object MD参数配置。 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称,取值范围:[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度:5 最大长度:64 labels 否 Array of strings 标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5 表5 TargetOptReceptor 参数 是否必选 参数类型 描述 file 是 ReceptorDrugFile object 受体文件。 balanced_charge 否 Boolean 是否平衡电荷。 缺省值:true water_model 否 String 水模型, 支持选择spc, spce, tip3p, tip4p, tip5p。 缺省值:tip3p force_field 否 String 蛋白立场,支持选择amber03, amber94, amber96, amber99, amber99sb, amber99sb-ildn, amberGS, charmm27, oplsaa, gromos43a1, gromos43a2, gromos45a3, gromos53a5, gromos53a6, gromos54a7。 缺省值:amber99sb ion_type 否 String 离子种类,支持选择NaCl、MgCl2、None,若设置了平衡电荷不支持选择None。 缺省值:NaCl ion_concentration 否 Float 离子浓度,单位mol/L,若离子种类设置为None离子浓度不支持设置。 最小值:0 最大值:5.0 缺省值:0.15 表6 ReceptorDrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format 否 String 文件格式,仅支持PDB,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data 否 String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表7 TargetOptLigand 参数 是否必选 参数类型 描述 file 是 ProbeDrugFile object 配体文件。 force_field 否 String 配体力场, 支持选择gaff, gaff2。 缺省值:gaff 表8 ProbeDrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format 否 String 文件格式,支持PDB、SDF、MOL2,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data 否 String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表9 MdParam 参数 是否必选 参数类型 描述 timestep_size 否 Float MD模拟的时间步长,单位fs,取值范围:大于0,小于等于5。 最小值:0 最大值:5.0 缺省值:2 temperature 否 Float MD模拟的温度,单位K。 最小值:0 最大值:1000.0 缺省值:300 step_params 否 MdStepParam object 计算步骤参数。 表10 MdStepParam 参数 是否必选 参数类型 描述 energy_minimization_steps 否 Integer 能量最小化的步骤。 最小值:1 最大值:50000 缺省值:10000 nvt 否 Float 等温等体步骤模拟的时长,单位ps。 最小值:0 最大值:1000.0 缺省值:200 npt 否 Float 等压等温步骤模拟的时长,单位ps。 最小值:0 最大值:1000.0 缺省值:500 simulation_time 否 Float 平衡步骤模拟的时长,单位ns。 最小值:0 最大值:50.0 缺省值:50
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/target-optimization 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "basic_info" : { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "labels" : [ "labelA", "labelB" ], "status" : "FINISHED", "type" : "ADMET", "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 }, "molecule_file" : { "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "count" : 1000 }, "job_result" : { "total_count" : 10, "failed_count" : 1 }, "cluster_result" : { "method" : "hiq_mc", "output_dir" : "project://bucket/path/to/task/dir/", "status" : "finished", "failed_reasons" : [ { "reason" : "failed reason" }, { "count" : 1 } ] }, "save_fingerprint" : true }
  • 响应参数 状态码: 200 表3 响应BoBy参数 参数 参数类型 描述 basic_info DrugJobDto object 作业基本信息。 molecule_file MoleculeFileDto object 分子文件。 job_result JobResult object 作业运行结果信息。 part_failed_reason Array of FailedReasonRecord objects 作业结果信息。 base_model BaseModel object 基模型。 models Array of BasicDrugModel objects 模型信息。 cluster_result ClusterJobRsp object 聚类结果信息。 save_fingerprint Boolean 是否输出表征。 表4 DrugJobDto 参数 参数类型 描述 id String 作业id。 name String 作业的名称,取值范围:[1,63],允许大小写字母、数字、以及特殊字符中划线(-)。 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 作业进度信息。 表5 Progress 参数 参数类型 描述 overall Float 整体进度。 estimated_finish_time Long 预计结束时间,毫秒。 表6 MoleculeFileDto 参数 参数类型 描述 file MoleculeFile object 分子文件。 count Integer 分子个数。 最小值:1 最大值:1000000 表7 MoleculeFile 参数 参数类型 描述 source String 文件来源,支持用户私有数据中心、公共数据和源数据。 最小长度:1 最大长度:8 url String 文件URL,用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format String 文件格式,支持PDB、SDF、MOL2、SMI,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表8 JobResult 参数 参数类型 描述 total_count Integer 输入总数。 failed_count Integer 失败个数。 表9 BaseModel 参数 参数类型 描述 id String 基模型id。 缺省值:pangu-drug-model 最小长度:1 最大长度:128 name String 基模型名称。 缺省值:pangu-drug-model 最小长度:1 最大长度:128 表10 BasicDrugModel 参数 参数类型 描述 id String 模型ID。 task_id String 任务ID。 name String 模型名称。 creator String 模型创建者。 type String 模型类型。 value_range ValueRange object 区间上下限,仅回归型存在。 description String 模型描述信息。 表11 ValueRange 参数 参数类型 描述 lower Float 区间下限,仅回归型存在。 upper Float 区间上限,仅回归型存在。 表12 ClusterJobRsp 参数 参数类型 描述 method String 分子聚类方法。 output_dir String 分子聚类输出结果。 status String 作业结果信息。 failed_reasons Array of FailedReasonRecord objects 部分失败原因和数量。 表13 FailedReasonRecord 参数 参数类型 描述 reason String 失败原因。 count Integer 失败数量。
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/admet/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 job_id 是 String 作业id。 最小长度:1 最大长度:128
  • 请求示例 创建分子搜索作业,作业名称为demo-job,分子SMILES表达式为string,从数据库中找到最相似top100的分子。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/search { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "smiles" : "string", "top_n" : 100, "databases" : [ "databaseA", "databaseB" ], "custom_databases" : [ "custom_databaseA_id", "custom_databaseB_id" ], "model_ids" : [ "model_id" ], "search_method" : [ "ECFP_4" ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 创建药物作业基本信息。 smiles 是 String 分子SMILES表达式。 最小长度:1 最大长度:1024 scaffold 否 String 分子骨架表达式。 最小长度:1 最大长度:1024 top_n 否 Integer 最相似的top_n个。 最小值:1 最大值:1000 缺省值:100 databases 否 Array of strings 可供搜索分子的公共数据库名称列表。 最小长度:1 最大长度:128 数组长度:0 - 10 custom_databases 否 Array of strings 可供搜索分子的自定义数据库id列表。 最小长度:1 最大长度:128 数组长度:0 - 10 model_ids 否 Array of strings 模型id列表。 最小长度:1 最大长度:128 数组长度:0 - 10 search_method 否 String 分子搜索方法。 枚举值: ECFP_4 SCAFFOLD 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称,取值范围:[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度:5 最大长度:64 labels 否 Array of strings 标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/search 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/toolkit/batch-download/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 task_id 是 String 下载任务ID。 最小长度:1 最大长度:128
  • 响应示例 状态码: 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 表3 响应Body参数 参数 参数类型 描述 basic_info DrugJobDto object 作业基本信息。 receptor ReceptorDrugFile object 受体文件。 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],允许大小写字母、数字、以及特殊字符中划线(-)。 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 作业进度信息。 表5 Progress 参数 参数类型 描述 overall Float 整体进度。 estimated_finish_time Long 预计结束时间,毫秒。 表6 ReceptorDrugFile 参数 参数类型 描述 source String 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format String 文件格式,仅支持PDB,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data String 文件原始数据,仅数据源为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 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format String 文件格式,支持PDB、SDF、MOL2、SMI,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表9 FepGraphDto 参数 参数类型 描述 center_id String 中心配体名称。 最小长度:1 最大长度:32 pairs Array of SimilarityDto objects 配体对列表。 数组长度:1 - 100 表10 SimilarityDto 参数 参数类型 描述 ligand_ids Array of strings 配体对。 最小长度:1 最大长度:32 数组长度:2 - 2 表11 FepParamDto 参数 参数类型 描述 pre_equilibrium_time Float 预平衡时长,单位ps,范围为0-200,不包含0,默认为100ps。 最小值:0 最大值:200.0 equilibrium_time Float 平衡时长,单位ns,范围为0-10,不包含0,默认为1ns。 最小值:0 最大值:10.0 num_pre_equilibrium_steps Integer 预平衡步数,默认为50000。 最小值:1 最大值:200000 num_equilibrium_steps Integer 平衡步数,默认为500000。 最小值:1 最大值:10000000 timestep_size Float 时间步长,单位ps,取值范围:大于0,小于等于0.005。 最小值:0.001 最大值:0.005 缺省值:0.002 num_lambda Integer lambda个数。 最小值:2 最大值:30 缺省值:20 表12 JobResult 参数 参数类型 描述 total_count Integer 输入总数。 failed_count Integer 失败个数。 表13 FailedReasonRecord 参数 参数类型 描述 reason String 失败原因。 count Integer 失败数量。
  • 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。 最小长度:1 最大长度:128 job_id 是 String 作业id。 最小长度:1 最大长度:128
  • 请求示例 创建自动作业,自动作业名称为demo-auto-job,使用如下数据库,使用数据库列为user_name。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs { "name" : "demo-auto-job", "description" : "description", "database_id" : "2adc4b5fbeeb4a518f177167074a5fb2", "database_column" : "user_name", "database_column_type" : "NEW", "clean_database_column" : false, "database_trigger" : [ { "name" : "status", "judge_mode" : "gte", "value" : "100" } ], "tool_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "tool_type" : "workflow", "job_name" : "demo-job", "job_name_type" : "AUTO", "job_description" : "description", "labels" : [ "labelA", "labelB" ], "priority" : 0, "timeout" : 1440, "output_dir" : "/job", "output_dir_type" : "MANUAL", "node_labels" : [ "health.node" ], "io_acc_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "tasks" : [ { "task_name" : "app1-1", "inputs" : [ { "name" : "dir-parameter", "source" : "MANUAL", "values" : [ "/test" ] } ], "resources" : { "cpu" : "1C", "cpu_type" : "X86", "memory" : "1G", "gpu_type" : "GPU", "gpu" : "0" }, "io_acc_type" : "SFS" } ] }
  • 响应示例 状态码: 201 CREATED { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "app_infos" : [ { "app_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "app_name" : "demo-app", "app_version" : "1.0.0", "app_node_labels" : [ "health.node" ] } ], "job_info" : { "job_name" : "demo-job", "job_node_labels" : [ "health.node" ] } }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 数据库名称,长度为5-32个字符,首位需以小写英文字母开头,仅可以使用小写字母、数字、下划线“_”和中划线“-”。 最小长度:5 最大长度:32 description 否 String 数据库描述。 最小长度:0 最大长度:1024 css_id 是 String css集群id。 最小长度:1 最大长度:128 file 是 DatabaseFile object 数据库文件。 columns 是 Array of strings 数据文件列名。 最小长度:1 最大长度:128 数组长度:2 - 12 shareable 否 Boolean 是否打开组织共享。 缺省值:false 表4 DatabaseFile 参数 是否必选 参数类型 描述 source 是 String 数据库文件来源。 枚举值: public private url 是 String 文件URL,用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 eihealth_project_id 否 String 数据库文件所在项目id,仅文件为数据中心时填写。 最小长度:1 最大长度:128
  • 请求示例 创建数据库,数据库名称为database_name,选择css集群,上传项目桶中file/test.csv的数据库数据,设置列名为SMILES和NAME,打开共享开关。 https://{endpoint}/v1/{project_id}/drug/drug-database { "name" : "database_name", "css_id" : "2f042ad4-6aca-11ed-b7f6-fa163e504fdd", "description" : "simple database", "file" : { "source" : "PRIVATE", "url" : "project:/file/test.csv", "eihealth_project_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" }, "columns" : [ "SMILES", "NAME" ], "shareable" : true }
  • 响应示例 状态码: 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" : { "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 } } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 basic_info DrugJobDto object 作业基本信息。 receptor TargetOptReceptor object 受体文件。 ligand TargetOptLigand object 配体文件。 md_params MdParam object MD参数配置。 表4 DrugJobDto 参数 参数类型 描述 id String 作业id。 name String 作业的名称,取值范围:[1,63],允许大小写字母、数字、以及特殊字符中划线(-)。 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 作业进度信息。 表5 Progress 参数 参数类型 描述 overall Float 整体进度。 estimated_finish_time Long 预计结束时间,毫秒。 表6 TargetOptReceptor 参数 参数类型 描述 file ReceptorDrugFileobject 受体文件。 balanced_charge Boolean 是否平衡电荷。 缺省值:true water_model String 水模型, 支持选择spc, spce, tip3p, tip4p, tip5p。 缺省值:tip3p force_field String 蛋白立场,支持选择amber03, amber94, amber96, amber99, amber99sb, amber99sb-ildn, amberGS, charmm27, oplsaa, gromos43a1, gromos43a2, gromos45a3, gromos53a5, gromos53a6, gromos54a7。 缺省值:amber99sb ion_type String 离子种类,支持选择NaCl、MgCl2、None,若设置了平衡电荷不支持选择None。 缺省值:NaCl ion_concentration Float 离子浓度,单位mol/L,若离子种类设置为None离子浓度不支持设置。 最小值:0 最大值:5.0 缺省值:0.15 表7 ReceptorDrugFile 参数 参数类型 描述 source String 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format String 文件格式,仅支持PDB,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表8 TargetOptLigand 参数 参数类型 描述 file ProbeDrugFile object 配体文件。 force_field String 配体力场, 支持选择gaff, gaff2。 缺省值:gaff 表9 ProbeDrugFile 参数 参数类型 描述 source String 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format String 文件格式,支持PDB、SDF、MOL2,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表10 MdParam 参数 参数类型 描述 timestep_size Float MD模拟的时间步长,单位fs,取值范围:大于0,小于等于5。 最小值:0 最大值:5.0 缺省值:2 temperature Float MD模拟的温度,单位K。 最小值:0 最大值:1000.0 缺省值:300 step_params MdStepParam object 计算步骤参数 表11 MdStepParam 参数 参数类型 描述 energy_minimization_steps Integer 能量最小化的步骤。 最小值:1 最大值:50000 缺省值:10000 nvt Float 等温等体步骤模拟的时长,单位ps。 最小值:0 最大值:1000.0 缺省值:200 npt Float 等压等温步骤模拟的时长,单位ps。 最小值:0 最大值:1000.0 缺省值:500 simulation_time Float 平衡步骤模拟的时长,单位ns。 最小值:0 最大值:50.0 缺省值:50
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/target-optimization/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 job_id 是 String 作业id。 最小长度:1 最大长度:128
共100000条