华为云用户手册

  • 上传数据方式 在开始执行分析作业前,请先上传待分析的原始数据。不同的上传方法对数据大小要求不同,您可以参考表 上传数据方式选择相应的数据上传方式。 表1 上传数据方式 上传数据方式 说明 “数据”页面上传 通过“数据”页面上传数据,支持上传最大为1GB的单个文件。 数据上传方法请参见“数据”页面上传。 使用命令行工具上传 命令行工具(eihealth-toolkit)配套 EIHealth 平台,提供数据、应用、流程和作业资源的管理和使用,支持上传最大为48.8TB的单个文件。 数据上传方法请参见命令行工具概述。
  • 操作记录 在操作记录页签,您可以按照“操作类型”、“资源类型”、“操作用户”、“项目名称”和“状态”对消息进行筛查。 例如,删除数据时,消息中心会显示数据所属的项目、资源的类型、删除操作的状态、操作人等信息。消息中心中呈现的内容请参见表 消息类型、表 执行状态说明。 图6 操作记录 表2 操作类型 操作类型 说明 PROJECT_DELETE 项目删除。某个项目开始删除、删除失败、删除成功时给予消息提示。 DELETE_DATA 数据删除。删除数据时给予消息提示,删除结果给予消息提示。 CLONE_DATA 数据拷贝。数据拷贝时给予消息提示,拷贝结果给予消息提示。 IMPORT_DATA 数据导入。数据导入时给予消息提示,导入结果给予消息提示。 ARCHIVE_DATA 归档数据。归档数据时给予消息提示,归档结果给予消息提示。 RESTORE_DATA 恢复数据。恢复数据时给予消息提示,恢复结果给予消息提示。 ARCHIVE_DATA_DELETE 删除归档数据。删除归档数据时给予消息提示,删除结果给予消息提示。 IMPORT_NETWORK_DATA 导入网络数据。导入网络数据时给予消息提示,导入结果给予消息提示。 SUBSCRIBE_DATA 订阅数据。订阅数据时给予消息提示,订阅结果给予消息提示。 DATABASE_IMPORT 导入数据库。导入数据时给予消息提示,导入结果给予消息提示。 JOB_STATUS 作业状态。作业的状态发生跳变时给予消息提示。 MESSAGE_CLEAN 消息清理。消息中心的消息总和超过设置值时,进行消息清理。 表3 执行状态说明 执行状态 说明 SUCCEED 执行成功。 FAILED 执行失败。 PRO CES SING 数据删除、导入等操作正在处理中。 START 项目删除操作开始执行。 RUNNING 分析作业运行中。 PENDING 分析作业等待处理中。 CANCELLED 取消作业。 对于“JOB_STATUS”类型的消息,可单击图标,跳转至对应的分析作业详情页面。您可以在该页面查看详细的运行信息。 消息通知 按照用户权限进行划分,只可以查看有权限访问的项目中的消息通知。
  • 设置项目存储容量 平台支持项目管理员以上角色,配置项目的最大存储量。 单击项目名称,在项目页面选择“设置”。 在项目详情页面,单击“已用存储量”后面的。 图6 设置存储容量 开启容量限制开关后,设置最大存储量。 图7 容量限制 设置成功后,单击“确定”。 项目存储量15分钟刷新一次,如果设置了项目最大存储量,项目数据达到最大存储量后,数据上传、复制、导入、执行的作业、notebook的使用会失败。
  • 添加项目成员 前提条件 平台管理员首先通过“用户管理”功能添加平台用户,才能将该用户添加至项目中。 创建用户的详细方法请参见创建平台用户。 存在一个创建好的项目。 操作步骤 添加项目成员有两种不同的方法,请任选其中一种方法操作。 方法一 单击项目名称,进入项目“设置”页。 单击“添加”,添加成员。 图1 添加成员 输入已添加至平台的用户的全称。 图2 输入用户名全称 单击“添加”,设置用户角色。详细成员角色介绍请参见表1。 图3 设置成员角色 单击“确认”,将用户添加至项目中。 方法二 在项目列表中,单击“操作”列“分享”。 图4 分享项目 输入已添加至平台的用户的全称。 图5 输入用户名全称 单击“添加”,设置用户角色。详细成员角色介绍请参见表1。 图6 设置成员角色 单击“确认”,将用户添加至项目中。
  • 查看项目详情 项目详情提供了项目中数据大小、成员、创建时间等信息,您可以通过以下两种方式查看项目信息。 查看项目概览 单击项目名称左侧图标,或双击项目行中的空白处,展开项目概览页面。您可以在该页面查看项目的描述、标签、创建时间、更新时间、是否核心项目、数据大小和成员信息。 图3 项目概览 查看项目详细信息 单击项目名称,进入项目“设置”页面。您可以在该页面,查看项目的数据存储量、作业总量、流程数量和应用数量,修改项目是否核心项目。 同时,可以查看项目的基本信息、数据控制信息和成员信息。 图4 项目详细信息
  • 项目状态 可用:项目当前状态正常。项目创建完成后进入“可用”状态,可用状态的项目允许被冻结、删除、转移和分享,执行此类操作需要该项目的成员拥有相关权限。 冻结:项目当前不可用。处于“冻结”状态的项目,用户无法进入该项目查看项目的开发环境、流程等历史运行情况。冻结的项目可以通过解冻操作重新激活。 删除中:项目删除中。需先冻结项目,才能执行删除操作。删除的核心项目,将进入“待删除项目”列表中。待删除项目会保留7天,6天内您可以将项目恢复成可用状态,最后一天不支持恢复。7天后,项目将自动删除,删除后不可恢复。非核心项目支持立即删除。 图5 项目状态
  • 操作步骤 登录华为云管理控制台,鼠标指向页面右上角的用户名,在下拉列表中单击“我的凭证”。 图1 我的凭证入口 在“我的凭证”页面中选择“访问密钥”页签。单击“新增访问密钥”,按操作指引获取认证账号的AK/SK,请妥善保管AK/SK信息。 图2 访问密钥 每个用户仅允许新增两个访问密钥。 为保证访问密钥的安全,访问密钥仅在初次生成时自动下载,后续不可再次通过管理控制台页面获取。请在生成后妥善保管。
  • 流程 EIHealth中的分析流程包含分析过程中所需应用的执行信息和数据的输入、输出等参数定义。 分析流程至少由一个应用组成,在多个应用构成的流程中,一个应用的输出作为另一个应用的输入,流程中的各个应用由其前后顺序形成完整的计算工作流。 分析流程通过流程设计器创建,创建好的流程将存储于项目中。同时,您也可以通过“导入流程”的方法,将隶属于其他项目的流程导入至自己的项目中。 创建好的流程显示在流程列表中,您可以基于这些流程创建分析作业。 详细的流程创建和运行请参见新建流程。
  • 镜像 运行生物信息学软件,往往由于不同的操作系统(Windows、Linux、Mac等)原因,无法实现统一的运维管理。同时,这些软件具有不同的版本和软件包,安装、使用过程复杂。将生物信息学软件封装成Docker镜像,可以使程序在不同的环境中运行,并通过EIHealth平台的镜像管理,实现高效的调用,极大方便了软件的安装和运行。 Docker镜像是一个模板,是容器应用打包的标准格式,在部署容器化应用时可以指定镜像。例如一个Docker镜像可以包含一个完整的Ubuntu操作系统环境,里面仅安装了用户需要的应用程序及其依赖文件。EIHealth平台使用 容器镜像服务 (Software Repository for Container,简称SWR)进行简单易用、安全可靠的镜像管理。
  • 应用 EIHealth平台的每一个分析作业都依托于应用运行。应用是生物信息学软件和运行该软件所依赖的运行环境的镜像封装,应用可以独立使用,也可以将多个应用编排入流程串联使用。 您可以在项目的应用列表中,查看隶属于该项目的应用,也可以通过搜索应用名称快速查找所需应用。应用列表展示了应用的名称、版本、创建者、修改时间、创建时间和可执行的操作。 详细的应用创建和使用请参见工具管理。 创建应用 应用是生物信息学软件的镜像封装,您可以制作软件镜像并上传至平台,并通过“新建应用”引入相关软件。 导入应用 应用按项目进行划分,隶属于不同项目的应用,可以通过“导入应用”的方法,导入至自己的项目中使用。
  • 请求参数 表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 params 是 SynthesisParamDto object 分子合成路径规划参数列表。 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称,取值范围:[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度:5 最大长度:64 labels 否 Array of strings 标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5 表5 SynthesisParamDto 参数 是否必选 参数类型 描述 top_n 是 Integer 期望最大返回条目数(排序后取TopN)。 最小值:1 最大值:50 max_search_depth 是 Integer 预测路径的最大深度。 最小值:3 最大值:12 time_limit 是 Integer 搜索最大时间,单位:分钟。 最小值:5 最大值:60 max_prediction_per_product 是 Integer 每个产物的最大反应数量。 最小值:2 最大值:20
  • 请求示例 创建分子合成路径规划作业,作业名称为demo-job。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/synthesis { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "smiles" : "c1ccccc1", "params" : { "top_n" : 50, "max_search_depth" : 5, "time_limit" : 30, "max_prediction_per_product" : 20 } }
  • 响应示例 状态码: 201 CREATED 创建分子合成路径规划作业成功。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" } 创建分子合成路径规划作业成功,当前运行作业数已达配额限制,此作业会等待。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/synthesis 表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,配体分别为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 受体的数据源:外部网络数据(如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 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
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-mol-design/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 job_id 是 String 作业id。 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "basic_info" : { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "labels" : [ "labelA", "labelB" ], "status" : "FINISHED", "type" : "POCKE_MOL_DESIGN", "start_time" : "2021-01-30T02:34:36Z", "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" } }, "ligands" : [ { "source" : "PRIVATE" }, { "url" : "project:/dir/file" } ], "cluster_result" : { "method" : "hiq_mc", "output_dir" : "project://bucket/path/to/task/dir/", "status" : "finished", "failed_reasons" : [ { "reason" : "failed reason" }, { "count" : 1 } ] } }
  • 请求示例 创建靶点口袋发现作业,作业名称为demo-job, 受体文件为project:/dir/file,时间步长为0.001ps,最小化步数为20000,预平衡时间为100ps,口袋发现时长为50ns,表面原子离散点数量为30,探针半径1.4A。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-detection { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "receptor" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "ligand" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "params" : { "timestep_size" : 0.001, "num_minimization_steps" : 20000, "pre_equilibrium_time" : 100, "pocket_detection_time" : 50, "num_surface_points" : 30, "probe_radius" : 1.4 } }
  • 响应示例 状态码: 201 CREATED 创建靶点口袋发现作业成功。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" } 创建靶点口袋发现作业成功,当前运行作业数已达配额限制,此作业会等待。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }
  • 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
  • 请求参数 表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 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: 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
  • 响应示例 状态码: 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 }
  • 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 最大结束时间
  • 响应参数 状态码: 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
  • 请求示例 创建分子优化作业,作业名称为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
共100000条