华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 workflows Array of NextflowWorkflowListDto objects 当前页的流程列表 count Integer 所查询类型的流程总数 表5 NextflowWorkflowListDto 参数 参数类型 描述 id String 流程id name String 流程名称 description String 描述信息 labels Array of strings 流程标签 create_time String 创建流程时间 update_time String 更新流程时间 creator String 创建用户名称 source_project_name String 源项目名称 source_resource_id String 源资源id

响应示例 状态码： 200 OK { "workflows" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-workflow", "description" : "description", "labels" : [ "labelA", "labelB" ], "create_time" : "2021-01-30T02:34:36Z", "update_time" : "2021-01-30T02:53:26Z", "creator" : "test-01", "source_project_name" : "src", "source_resource_id" : "src-id" } ], "count" : 1 }

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

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases/{database_id}/data/{row_num} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 database_id 是 String 数据库实例id 最小长度：1 最大长度：128 row_num 是 Long 数据的行号，即_row_num值 最小值：0 最大值：2147483647

请求示例 设置受体蛋白文件为1TQN.pdb，配体小分子为1TQN.pdb，拼接成复合物结构。 https://{endpoint}/v1/{project_id}/drug-common/toolkit/surface-points { "receptor" : { "file" : { "source" : "EXTRANET", "url" : "https://files.rcsb.org/download/1TQN.pdb" } }, "ligand" : { "source" : "EXTRANET", "url" : "https://files.rcsb.org/download/1TQN.pdb" } }

响应示例 状态码： 200 蛋白小分子拼接复合物结果字符串。 REMARK 1 CREATED WITH OPENMM 7.7, 2023-10-31 CRYST1 48.140 48.140 135.230 90.00 90.00 90.00 P 1 1 ATOM 1 N ALA A 1 35.884 42.999 47.573 1.00 0.00 N ATOM 2 H ALA A 1 35.251 42.514 48.472 1.00 0.00 H ATOM 3 H2 ALA A 1 34.961 43.642 47.135 1.00 0.00 H ATOM 4 H3 ALA A 1 36.444 43.875 48.190 1.00 0.00 H ATOM 5 CA ALA A 1 36.605 42.605 46.370 1.00 0.00 C ATOM 6 HA ALA A 1 36.266 43.206 45.396 1.00 0.00 H ATOM 7 C ALA A 1 36.452 41.114 46.099 1.00 0.00 C ATOM 8 O ALA A 1 36.341 40.696 44.945 1.00 0.00 O ... HETATM 32 C4 UNL Z 1 -1.619 0.123 -1.621 +0.00 +0.00 C HETATM 33 C5 UNL Z 1 -0.461 0.209 -0.648 +0.00 -0.00 C HETATM 34 C6 UNL Z 1 0.464 1.262 -0.731 +0.00 +0.00 C HETATM 35 C7 UNL Z 1 1.530 1.346 0.178 +0.00 +0.00 C HETATM 36 C9 UNL Z 1 1.653 0.391 1.191 +0.00 +0.00 C HETATM 37 C10 UNL Z 1 0.748 -0.676 1.263 +0.00 +0.00 C HETATM 38 C11 UNL Z 1 -0.302 -0.765 0.348 +0.00 +0.00 C HETATM 39 C8 UNL Z 1 2.511 2.436 -0.027 +0.00 +0.00 C HETATM 40 O2 UNL Z 1 3.062 3.028 0.891 +0.00 -0.00 O HETATM 41 C12 UNL Z 1 2.682 0.463 2.236 +0.00 +0.00 C HETATM 42 O4 UNL Z 1 3.273 -0.478 2.728 +0.00 -0.01 O HETATM 43 O3 UNL Z 1 2.796 1.722 2.692 +0.00 -0.01 O HETATM 44 H12 UNL Z 1 3.751 1.920 2.595 +0.00 +0.00 H TER ENDMDL

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限， 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 receptor 是 RunReceptorPreprocessReq object 受体蛋白文件。 ligand 是 ReceptorDrugFileReq object 配体小分子文件。 表4 RunReceptorPreprocessReq 参数 是否必选 参数类型 描述 file 是 ReceptorDrugFileReq object 受体文件。 remove_water 否 Boolean 去除水分子。 缺省值：false remove_ion 否 Boolean 去除离子。 缺省值：false remove_ligand 否 Boolean 去除配体分子。 缺省值：false add_hydrogen 否 Boolean 增加氢原子。 缺省值：false 表5 ReceptorDrugFileReq 参数 是否必选 参数类型 描述 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 add_hydrogen 否 Boolean 增加氢原子。 缺省值：true

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

响应示例 状态码： 200 OK [ { "id" : "0era3396d980d45f1fJ3DGW345af8", "name" : "demo-user", "status" : "SUC CES S" } ] 状态码： 207 MULTI_STATUS [ { "id" : "0era3396d980d45f1fJ3DGW345af8", "name" : "demo-user", "status" : "FAILED", "failed_reason" : "Internal error." } ]

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchDeleteMemberRsp objects OK 表6 BatchDeleteMemberRsp 参数 参数类型 描述 id String 用户id name String 用户名 status String 删除结果 failed_reason String 失败原因 状态码： 207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchDeleteMemberRsp objects MULTI_STATUS 表8 BatchDeleteMemberRsp 参数 参数类型 描述 id String 用户id name String 用户名 status String 删除结果 failed_reason String 失败原因

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 members 是 Array of MemberDto objects 删除用户列表 数组长度：1 - 5 表4 MemberDto 参数 是否必选 参数类型 描述 user_id 是 String 用户id 最小长度：1 最大长度：128

请求示例 批量移除项目成员，指定需要移除的成员的用户id https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/batch-delete { "members" : [ { "user_id" : "0era3396d980d45f1fJ3DGW345af8" } ] }

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

请求示例 导入模板，从ID为56e0f1b0-ac10-46a5-8fa7-b26831d7d488的项目导入名为import-template的模板 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates/batch-import { "source_project_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "import_templates" : [ { "source_template_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "destination_template_name" : "import-template" } ] }

响应示例 状态码： 200 OK [ { "source_project_id" : "46e0f1b0-ac10-46a5-8fa7-b26831d7d488", "source_template_id" : "76e0f1b0-ac10-46a5-8fa7-b26831d7d488", "destination_template_id" : "86e0f1b0-ac10-46a5-8fa7-b26831d7d488", "destination_template_name" : "imported-template", "failed_reason" : null, "status" : "success" } ] 状态码： 207 MULTI_STATUS [ { "source_project_id" : "46e0f1b0-ac10-46a5-8fa7-b26831d7d488", "source_template_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "destination_template_id" : "66e0f1b0-ac10-46a5-8fa7-b26831d7d488", "destination_template_name" : "imported-template", "failed_reason" : "failed reason", "status" : "fail" } ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 source_project_id 是 String 源项目id 最小长度：1 最大长度：128 import_templates 是 Array of TemplateSrcReq objects 导入模板列表 数组长度：1 - 10 表4 TemplateSrcReq 参数 是否必选 参数类型 描述 source_template_id 是 String 源模板id 最小长度：1 最大长度：128 destination_template_name 是 String 导入模板名称 最小长度：3 最大长度：32

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportTemplateResultRsp objects OK 表6 ImportTemplateResultRsp 参数 参数类型 描述 source_project_id String 源项目id source_template_id String 源模板id destination_template_id String 导入后的模板id destination_template_name String 导入后的模板名称 failed_reason String 失败原因，导入失败会返回 status String 导入结果 状态码： 207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportTemplateResultRsp objects MULTI_STATUS 表8 ImportTemplateResultRsp 参数 参数类型 描述 source_project_id String 源项目id source_template_id String 源模板id destination_template_id String 导入后的模板id destination_template_name String 导入后的模板名称 failed_reason String 失败原因，导入失败会返回 status String 导入结果

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates/batch-import 表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-Bucket-Name 否 String X-Bucket-Name 最小长度：1 最大长度：128 X-Namespace-Name 否 String X-Namespace 最小长度：1 最大长度：128

响应示例 状态码： 200 OK { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda", "name" : "demo-project", "obs_bucket_name" : "eihealth-demo-project-sjdj3", "swr_namespace" : "eihealth-demo-project-sjdj3", "tags" : [ "tag1" ], "description" : "This is demo project", "creator" : "demo-user", "role" : "Admin", "roles" : [ { "role_type" : "Admin", "users" : [ { "id" : "adb1376b-72f9-4d15-9f95-9b533cb96dce", "name" : "demo-user" } ] } ], "size" : 1123243535, "status" : "TO_BE_DELETED", "update_time" : "2020-09-10T10:07:17Z", "create_time" : "2020-09-10T10:07:17Z", "delete_time" : "2020-09-10T10:07:17Z" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 项目id name String 项目名称 obs_bucket_name String 项目桶名 swr_namespace String 项目组织名 creator String 项目所有者 role String 当前用户在该项目上的角色 roles Array of ProjectRoleRsp objects 项目角色列表 size Long 项目桶存储量 status String 项目状态 tags Array of strings 标签列表 description String 项目描述 create_time String 项目创建时间 update_time String 项目更新时间 delete_time String 请求删除时间 is_core Boolean 是否为核心项目 storage_quota Long 项目数据容量配额，-1表示无容量限制 表4 ProjectRoleRsp 参数 参数类型 描述 role_type String 项目角色名 users Array of BindUserRsp objects 项目成员列表 表5 BindUserRsp 参数 参数类型 描述 id String 项目成员用户id name String 项目成员用户名

URI GET /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 表3 FormData参数 参数 是否必选 参数类型 描述 workflow_file 否 File 流程文件，文件大小[0,10M] description 否 String 流程描述 取值范围[0,65535] 最小长度：0 最大长度：65535 labels 否 Array of strings 流程标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。 最小长度：1 最大长度：32 数组长度：0 - 5 main_file 否 String 主文件名 最小长度：4 最大长度：1023 params 否 File 流程参数列表文件，取值范围[0, 10M]

请求示例 更新Nextflow流程，修改流程描述为description，标签为labelA,labelB，流程主文件为main.nf https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/workflows/baabcb56-5bb6-11eb-8a0d-fa163e3ddba1 { "description" : "description", "labels" : "labelA,labelB", "workflow_file" : "(binary)", "main_file" : "main.nf" }

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

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

响应示例 状态码： 200 OK { "label_pages" : [ { "id" : "111122c4-5fb5-11eb-8a0d-fa163e3ddba1", "name" : "脑科学", "feature" : "TOOL", "labels" : [ "labelA" ], "creator" : "string" } ], "count" : "1" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 label_pages Array of LabelPageListDto objects 标签页面列表 count Integer 标签页面总条数 表4 LabelPageListDto 参数 参数类型 描述 id String 标签页面id name String 标签页面标题 feature String 标签页面类型 labels Array of strings 标签页面包含的标签 creator String 标签页面创建者

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id} 表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参数 参数 是否必选 参数类型 描述 x_coord_list 是 Array of floats x坐标集。 最小值：-9999999 最大值：99999999 数组长度：1 - 500 y_coord_list 是 Array of floats y坐标集。 最小值：-9999999 最大值：99999999 数组长度：1 - 500 z_coord_list 是 Array of floats z坐标集。 最小值：-9999999 最大值：99999999 数组长度：1 - 500