华为云用户手册

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/workflows/subscribe 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

请求示例 创建notebook，使用系统默认镜像，需要cpu资源1C，内存资源5G。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks { "flavor" : { "cpu" : 1, "gpu" : 0, "memory" : 5 }, "image" : { "image_type" : "SYSTEM", "image_info" : { "profile" : "PY3" } }, "storages" : [ { "path" : "OBSFS:test-bucket:/" } ], "name" : "test-notebook", "description" : "test" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 描述信息，取值范围[0,1024] 最小长度：0 最大长度：1024 storages 是 Array of NotebookStorage objects 挂载信息 数组长度：1 - 6 flavor 是 FlavorInfo object notebook规格 image 是 NotebookImage object 镜像信息 name 是 String notebook名称，取值范围[1,63],仅支持小写字母、数字、中划线(-),开始只能是小写字母，结束只能是小写字母或数字 最小长度：1 最大长度：63 表4 NotebookStorage 参数 是否必选 参数类型 描述 path 是 String notebook存储路径 最小长度：1 最大长度：4096 mount_path 否 String 挂载路径，由于目前暂不支持自定义挂载，暂不开放 最小长度：1 最大长度：4096 表5 FlavorInfo 参数 是否必选 参数类型 描述 cpu 是 Float notebook占用的cpu,0.1核为100m,单位为"C" 最小值：1 最大值：128 缺省值：1 gpu 是 Float notebook占用的gpu，0.1为使用单卡10%，1为占满单个显卡，1+为使用多个显卡 最小值：0 最大值：16 缺省值：0 memory 是 Float notebook占用的内存,单位为"G" 最小值：2 最大值：512 缺省值：2 表6 NotebookImage 参数 是否必选 参数类型 描述 image_type 是 String 镜像类型 枚举值： SYSTEM CUSTOMER image_info 是 ImageInfo object 镜像信息 表7 ImageInfo 参数 是否必选 参数类型 描述 source_project_name 否 String 源项目名 最小长度：1 最大长度：128 image_name 否 String 镜像名 最小长度：1 最大长度：128 image_tag 否 String 镜像tag名 最小长度：1 最大长度：64 profile 否 String 系统镜像名 枚举值： PY3

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID。 最小长度：1 最大长度：128 job_id 是 String 作业id。 最小长度：1 最大长度：128

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/images/{image_id}/tags/batch-delete 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 image_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参数 参数 是否必选 参数类型 描述 tags 是 Array of strings 删除镜像tag名称列表 最小长度：1 最大长度：64 数组长度：1 - 10

响应示例 状态码： 200 OK [ { "tag" : "v1.0", "status" : "SUCCESS" }, { "tag" : "v2.0", "status" : "SUCCESS" } ] 状态码： 207 MULTI_STATUS [ { "tag" : "v1.0", "status" : "FAILED", "failed_reason" : "Internal error." }, { "tag" : "v2.0", "status" : "SUCCESS" } ]

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of DeleteTagRsp objects OK 表5 DeleteTagRsp 参数 参数类型 描述 tag String 镜像tag名称 status String 删除结果 failed_reason String 失败原因 状态码： 207 表6 响应Body参数 参数 参数类型 描述 [数组元素] Array of DeleteTagRsp objects MULTI_STATUS 表7 DeleteTagRsp 参数 参数类型 描述 tag String 镜像tag名称 status String 删除结果 failed_reason String 失败原因

请求示例 批量删除镜像版本，删除v1.0,v2.0版本 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/images/{image_id}/tags/batch-delete { "tags" : [ "v1.0", "v2.0" ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 作业日志条数 logs Array of LogContentDto objects 作业日志内容列表 log_storage_link String 作业日志存储链接 表5 LogContentDto 参数 参数类型 描述 collect_time String 作业日志采集时间 content String 作业日志内容

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 job_id 是 String 作业id 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 task_name 是 String 子任务名称 缺省值：task0 最小长度：1 最大长度：128 task_index 否 String 子任务并发的序号 缺省值：0 最小长度：1 最大长度：128

响应示例 状态码： 200 OK [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "status" : "SUCCEEDED", "message" : "string" } ] 状态码： 207 MULTI_STATUS [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "status" : "SUCCEEDED", "message" : "string" }, { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2", "status" : "FAILED", "message" : "string" } ]

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-delete 表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。 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 批量操作作业id列表 最小长度：1 最大长度：128 数组长度：1 - 50

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchOperateJobRsp objects OK 表5 BatchOperateJobRsp 参数 参数类型 描述 id String 作业id status String 批量操作作业的结果 枚举值： SUCCEEDED FAILED message String 操作结果失败信息，仅在操作失败时会返回 状态码： 207 表6 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchOperateJobRsp objects MULTI_STATUS 表7 BatchOperateJobRsp 参数 参数类型 描述 id String 作业id status String 批量操作作业的结果 枚举值： SUCCEEDED FAILED message String 操作结果失败信息，仅在操作失败时会返回

请求示例 批量删除作业，删除如下两个作业。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-delete { "ids" : [ "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2" ] }

响应示例 状态码： 200 OK { "id" : "aa78f595-5acb-4be8-b277-229be335633a", "name" : "Docking Summary", "title" : "Docking Summary", "category" : "WORKFLOW", "labels" : [ "molecular docking", "drug discovery", "smallMolecularChemicals" ], "vendor_id" : "00000000000000000000000000000000", "version" : { "version" : "1.0.0", "publisher" : "EIHealth", "description" : "", "summary" : "summary", "license" : "", "status" : "NORMAL", "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z" }, "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z" }

URI GET /v1/{project_id}/assets/{asset_id}/versions/{version} 表1 路径参数 参数 是否必选 参数类型 描述 asset_id 是 String 资产id 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 version 是 String version 最小长度：1 最大长度：128

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 资产id name String 资产名 title String 资产展示名 category String 类别 labels Array of strings 资产标签列表 vendor_id String 供应商id version VersionRsp object 资产版本信息 create_time String 创建时间 update_time String 更新时间 表4 VersionRsp 参数 参数类型 描述 version String 资产版本号 publisher String 发布者 description String 资产长描述 summary String 资产短描述 license String 许可证 status String 资产状态 failed_reason String 资产发布失败原因 labels Array of strings 资产标签列表 picture String 资产封面图访问链接 create_time String 创建时间 update_time String 更新时间

响应示例 状态码： 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

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表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 X-Delete-Now 否 Boolean 非核心项目删除立即删除标记 缺省值：false

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 用户名，长度5~31之间，首位不能为数字，特殊字符只能包含下划线“_”、中划线“-”和空格 最小长度：5 最大长度：32 password 是 String 用户密码，在8-32位之间支持用户自定义密码长度，至少包含以下四种字符中的两种： 大写字母、小写字母、数字和特殊字符。 最小长度：8 最大长度：32 role 是 String 角色类型：管理员(ADMIN)、操作者(OPERATOR) 最小长度：1 最大长度：64 email 否 String 用户邮箱，需符合邮箱格式 最小长度：0 最大长度：128 phone 否 String 用户手机号，纯数字，长度小于等于32位。必须与国家码同时存在。 最小长度：5 最大长度：32 areacode 否 String 国家码。中国大陆为“0086” 最小长度：1 最大长度：10 settings 否 UserSettingDto object 用户设置 表4 UserSettingDto 参数 是否必选 参数类型 描述 job_quota 是 Integer 允许同时运行的作业数 最小值：1 最大值：100 job_timeout 是 Integer 作业执行超时时长，单位天 最小值：1 最大值：60 cpu_quota 是 Integer 作业的CPU资源配额，单位核 最小值：1 最大值：1024 mem_quota 是 Integer 作业的内存资源配额，单位GB 最小值：1 最大值：1024 projects_per_user 否 Integer 用户可创建项目数配额 最小值：0 最大值：20 缺省值：2

请求示例 创建用户，用户名为example_user，密码为example，角色为ADMIN，邮箱为example@huawei.com，电话为12345678910，作业配额为10，作业超时时长为1天，CPU的核数配额为50，内存的配额为128GB，用户可创建的项目数为2 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users { "name" : "example_user", "password" : "example", "role" : "ADMIN", "email" : "example@huawei.com", "phone" : "12345678910", "areacode" : "0086", "settings" : { "job_quota" : 10, "cpu_quota" : 50, "mem_quota" : 128, "job_timeout" : 1, "projects_per_user" : 2 } }

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 job_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 策略名称 最小长度：1 最大长度：64 max_nodes 否 Integer 扩容节点数上限 最小值：0 最大值：50 min_nodes 否 Integer 扩容节点数下限 最小值：0 最大值：50 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

请求示例 更新扩容策略配置，更改名称为strategy_4vCPUS_8GB https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/system/autoscaler/scale-out-policies/{id} { "name" : "strategy_4vCPUS_8GB", "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 }