华为云用户手册

请求示例 更新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

请求示例 设置离散点坐标集为x_coord_list[0.1, 0.2, 0.3]、y_coord_list[0.1, 0.2, 0.3、z_coord_list[0.1, 0.2, 0.3]生成可渲染的文件内容。 https://{endpoint}/v1/{project_id}/drug-common/toolkit/surface-points { "x_coord_list" : [ 0.1, 0.2, 0.3 ], "y_coord_list" : [ 0.1, 0.2, 0.3 ], "z_coord_list" : [ 0.1, 0.2, 0.3 ] }

响应示例 状态码： 200 表面离散点生成的字符串结果。 ATOM 1 H UNK X 1 25.6832614.2765035.85524 ATOM 2 H UNK X 1 48.8256029.921632.635054 ATOM 3 H UNK X 1 30.3003147.8117043.76887 ATOM 4 H UNK X 1 33.9991343.3179329.87190 ATOM 5 H UNK X 1 8.32594730.4173222.69595 ATOM 6 H UNK X 1 43.2972922.363610.997845 ATOM 7 H UNK X 1 48.2033511.4456930.39213 ATOM 8 H UNK X 1 47.1369030.1526120.76086 ATOM 9 H UNK X 1 8.18054139.089091.179204 ATOM 10 H UNK X 1 34.2400436.849482.367979 ATOM 11 H UNK X 1 34.7073824.577241.094519 ATOM 12 H UNK X 1 9.17813040.0974720.49336 ATOM 13 H UNK X 1 35.6577641.6438416.73472 ATOM 14 H UNK X 1 12.7789236.2953716.31348

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/toolkit/surface-points 表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参数 参数 是否必选 参数类型 描述 description 否 String 归档描述，最大长度为1000 最小长度：0 最大长度：1000 name 是 String 归档名称,最大长度为100 最小长度：1 最大长度：100 sub_paths 是 Array of strings 归档路径集 最小长度：1 最大长度：2000 数组长度：1 - 50 storage_type 否 String 存储类型，可选择标准（STANDARD）或归档存储（COLD） 枚举值： STANDARD COLD delete_archived_data 否 Boolean 是否删除已归档数据

请求示例 归档数据，归档模式为STANDARD，归档的子路径为folder1和folder2。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups { "name" : "归档2021", "sub_paths" : [ "folder1/", "folder2/" ], "storage_type" : "STANDARD", "delete_archived_data" : false, "description" : "归档2021" }

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups 表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 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 项目描述 最小长度：0 最大长度：1024 name 是 String 项目名称 最小长度：3 最大长度：45 tags 否 Array of strings 标签 最小长度：1 最大长度：32 数组长度：0 - 5 is_core 否 Boolean 是否核心项目 缺省值：true is_new_bucket 否 Boolean 是否新桶, 仅气象支持该字段 bucket_name 否 String 桶名, 仅气象支持该字段 最小长度：3 最大长度：63

请求示例 订阅应用，订阅后应用名称为dest_app_name，应用版本为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/subscribe { "asset_id" : "7513f7c2-eed5-4ebb-bd7d-cee85a87a338", "asset_version" : "1.0.0", "destination_app_name" : "dest_app_name", "destination_app_version" : "1.0.0" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 asset_id 是 String 资产id。长度1-128，只能包含字母、数字、下划线和中划线 最小长度：1 最大长度：128 asset_version 是 String 资产版本。长度1-128，字母或数字开头，后面跟小写字母、数字、小数点、斜杠、下划线或中划线 最小长度：1 最大长度：128 destination_app_name 是 String 目标应用名称 取值范围：长度为[1,56]，以大小写字母开头，允许出现中划线(-)、下划线(_)、小写字母和数字，且必须以大小写字母或数字结尾。 最小长度：1 最大长度：56 destination_app_version 是 String 目标应用版本。取值范围：长度[1,24]，以小写字母或数字或大写字母开头，允许出现中划线，必须以小写字母或数字或大写字母结尾。 最小长度：1 最大长度：24

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/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" : "SUC CES S" }, { "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