华为云用户手册

  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/label-pages/{label_page_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。 最小长度:1 最大长度:128 label_page_id 是 String 标签页面ID。 最小长度:1 最大长度:128
  • 请求示例 批量更新消息状态为已读。 https://{endpoint}/v1/{project_id}/notices/batch-update { "notice_ids" : [ "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2" ], "operation" : "read" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 notice_ids 是 Array of strings 批量更新通知消息ID列表。 最小长度:1 最大长度:128 数组长度:1 - 50 operation 是 String 枚举值: read
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 job_retain_number 是 Integer 作业保存条数。 最小值:10000 最大值:10000000
  • 请求示例 创建扩容策略,指定名称为trategy_4vCPUS_8GB。 https://{endpoint}/v1/{project_id}/system/autoscaler/scale-out-policies { "name" : "strategy_4vCPUS_8GB", "availability_zone" : "region_id", "spec_code" : "eihealth.xxx.spec.xxx.xxx", "max_nodes" : 50, "min_nodes" : 0, "cpu_rule_enable" : true, "cpu_percent" : 80, "add_nodes_for_cpu_rule" : 1, "mem_rule_enable" : true, "mem_percent" : 80, "add_nodes_for_mem_rule" : 1 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 策略名称。 最小长度:1 最大长度:64 availability_zone 是 String 可用区。 最小长度:1 最大长度:64 spec_code 是 String 规格编码。 最小长度:1 最大长度:64 max_nodes 是 Integer 扩容节点数上限。 最小值:0 最大值:50 min_nodes 是 Integer 扩容节点数下限。 最小值:0 最大值:50 data_disk_spec_code 否 String 额外数据盘规格编码。 最小长度:1 最大长度:64 data_disk_size 否 Integer 额外数据盘大小。 最小值:100 最大值:32768 cpu_rule_enable 是 Boolean 是否启用cpu规则。 cpu_percent 是 Integer cpu分配率百分比。 最小值:1 最大值:100 add_nodes_for_cpu_rule 是 Integer 满足扩容策略中cpu分配率时增加的节点数。 最小值:1 最大值:50 mem_rule_enable 是 Boolean 是否启用mem规则。 mem_percent 是 Integer mem分配率百分比。 最小值:1 最大值:100 add_nodes_for_mem_rule 是 Integer 满足扩容策略中mem分配率时增加的节点数。 最小值:1 最大值:50
  • 响应示例 状态码: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 响应Body参数 参数 参数类型 描述 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],允许大小写字母、数字、以及特殊字符中划线(-)。 eihealth_project_id String 作业所属空间ID。 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 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 失败个数。 sub_tasks_duration Array of floats 子任务运行时长(秒)。 数组长度:1 - 30 num_molecules Integer 分子聚类任务中的分子总数。 success_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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作:重试、取消、下线。 枚举值: RETRY CANCEL OFFLINE
  • URI POST /v1/{project_id}/assets/{asset_id}/versions/{version}/action 表1 路径参数 参数 是否必选 参数类型 描述 asset_id 是 String 资产ID。 最小长度:1 最大长度:128 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 version 是 String version 最小长度:1 最大长度:128
  • URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/{path}/policy 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。 最小长度:1 最大长度:128 path 是 String 对象全路径(空间名称:|路径)。 最小长度:1 最大长度:2000 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参数 参数 是否必选 参数类型 描述 delete_policy 是 String 枚举值: allow deny
  • 请求示例 创建靶点优化作业,作业名称为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 } } }
  • 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
  • 请求参数 表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 upstream_job_info 否 String 上游作业信息。 最小长度:1 最大长度:10240 表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 受体的数据源:外部网络数据(如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 表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
  • 响应示例 状态码: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 } }
  • 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
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 basic_info DrugJobDto object 作业基本信息。 receptor ReceptorDrugFile object 受体文件。 add_membrane Boolean 是否加膜处理。 缺省值:false 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],允许大小写字母、数字、以及特殊字符中划线(-)。 eihealth_project_id String 作业所属空间ID。 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 受体的数据源:外部网络数据(如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 失败个数。 sub_tasks_duration Array of floats 子任务运行时长(秒)。 数组长度:1 - 30 num_molecules Integer 分子聚类任务中的分子总数。 success_count Integer 聚类成功的分子数。 表13 FailedReasonRecord 参数 参数类型 描述 reason String 失败原因。 count Integer 失败数量。
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/similarity-graph/{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 { "count" : 1, "resources" : [ { "spec" : { "code" : "code", "name" : "name" }, "size" : 1024, "charge_mode" : 2, "create_time" : "2021-02-01T14:25:50Z", "status" : "Deploying" } ] }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 count Integer 存储资源总数。 resources Array of StorageResourceRsp objects 存储资源列表。 表4 StorageResourceRsp 参数 参数类型 描述 spec SpecDto object 规格信息。 size Long 使用量。 charge_mode String 计费模式。 create_time String 购买时间。 status String 状态。 表5 SpecDto 参数 参数类型 描述 code String 规格编号。 最大长度:64 name String 规格名称。 最大长度:64
  • 响应示例 状态码:200 OK { "count" : 0, "resources" : [ { "id" : "string", "resource_id" : "string", "spec" : { "code" : "string", "name" : "string" }, "disk" : { "type" : "string", "space" : 0, "encrypt" : true, "used" : 0 }, "charge_mode" : "string", "period_num" : 0, "create_time" : "2021-09-02T11:51:30Z", "status" : "DEPLOYING" } ] }
  • 响应参数 状态码:200 表3 响应Header参数 参数 参数类型 描述 X-Resource-Mappings String 业务ID与资源ID的映射关系。 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 resources Array of DatabaseResourceRsp objects 数据库资源列表。 表5 DatabaseResourceRsp 参数 参数类型 描述 id String 实例ID。 resource_id String 资源ID。 spec DatabaseSpecDto object 规格信息。 disk DatabaseDiskDto object 磁盘信息。 charge_mode String 计费模式。 period_num Integer 购买周期。 create_time String 购买时间,UTC时间。 failure_reason String 失败原因。 status String 枚举值: DEPLOYING NORMAL UPDATINTG ABNORMAL FREEZE DELETING 表6 DatabaseSpecDto 参数 参数类型 描述 code String 规格编号。 最大长度:64 name String 规格名称。 最大长度:64 表7 DatabaseDiskDto 参数 参数类型 描述 type String 磁盘类型。 space Integer 磁盘大小,单位GB。 encrypt Boolean 是否加密。 used Double 磁盘已使用量,单位GB。
  • 请求示例 创建自由能微扰作业,作业名称为demo-job,受体文件为project:/dir/file,配体分别为GLY:A:514和UNK1,路径图的中心配体为GLY:A:514,配体对分别为GLY:A:514和DrugBank:UNK1,预平衡步数为5000,平衡步数为50000,时间步长为0.002,lambda的个数为20。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/fep { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "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 } }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/fep 表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 创建药物作业基本信息。 receptor 是 ReceptorDrugFile object 受体文件。 add_membrane 否 Boolean 是否加膜处理。 缺省值:false ligands 是 Array of LigandPreviewDto objects 配体列表。 数组长度:2 - 101 graph 是 FepGraphDto object 路径图 params 是 FepParamDto object FEP设置参数。 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称,长度范围[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度:5 最大长度:64 labels 否 Array of strings 标签,长度范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线(_)和中划线(-),且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5 upstream_job_info 否 String 上游作业信息。 最小长度:1 最大长度:10240 表5 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 表6 LigandPreviewDto 参数 是否必选 参数类型 描述 index 是 Integer 配体索引(从0起编号)。 最小值:0 最大值:99 file 是 DrugFile object 配体文件。 name 是 String 配体名称,如果无名称则自动命名,格式为UNK+索引(从1起编号)。 最小长度:1 最大长度:32 smiles 是 String 分子SMILES表达式。 最小长度:1 最大长度:512 表7 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 表8 FepGraphDto 参数 是否必选 参数类型 描述 center_id 是 String 中心配体名称。 最小长度:1 最大长度:32 pairs 是 Array of SimilarityDto objects 配体对列表。 数组长度:1 - 100 表9 SimilarityDto 参数 是否必选 参数类型 描述 ligand_ids 是 Array of strings 配体对。 最小长度:1 最大长度:32 数组长度:2 - 2 表10 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
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 status String 任务状态。 result LigandSimilarityGraphTaskResultDto object 配体相似度图任务结果。 表4 LigandSimilarityGraphTaskResultDto 参数 参数类型 描述 pairs Array of LigandSimilarityGraphTaskResultPairDto objects 配体相似度图任务结果对列表。 数组长度:1 - 100 表5 LigandSimilarityGraphTaskResultPairDto 参数 参数类型 描述 ligands Array of strings 两个配体名称。 最小长度:1 最大长度:32 数组长度:2 - 2 success Boolean 相似度计算是否成功。 similarity Float 配体对之间的相似度。 最小值:0 最大值:1 reason String 相似度计算失败的理由。 最小长度:1 最大长度:512
  • 响应示例 状态码:200 查询配体相似性图计算任务成功响应。 { "status" : "finished", "result" : { "pairs" : [ { "success" : true, "ligands" : [ "FXR_74", "ligand" ], "similarity" : 0, "reason" : null } ] } }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/similarity-graph/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 空间ID。 最小长度:1 最大长度:128 task_id 是 String 任务ID,通过创建任务接口取得。 最小长度:1 最大长度:128
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全