云服务器内容精选

  • 响应示例 状态码: 201 CREATED 创建自由能微扰作业成功。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" } 创建自由能微扰作业成功,当前运行作业数已达配额限制,此作业会等待。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }
  • 请求示例 创建自由能微扰作业,作业名称为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 } }
  • 请求参数 表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 受体文件。 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 表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
  • 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
  • 响应示例 状态码: 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