华为云用户手册

  • 请求示例 导入应用,导入后应用名称为dest-demo-app,版本为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/batch-import { "source_project_id" : "3ce0f1b0-ac10-46a5-8fa7-b16831d7d480", "import_apps" : [ { "destination_app_name" : "dest-demo-app", "destination_app_version" : "1.0.0", "source_app_id" : "2b4b1836-5967-11eb-8a0d-fa163e3ddba1" } ] }
  • 响应示例 状态码: 200 OK [ { "source_app_id" : "328e5b04-f5f4-6528-3af1-a10790835f73", "destination_app_id" : "7513f7c2-eed5-4ebb-bd7d-cee85a87a338", "destination_app_name" : "dest_app_name", "version" : "1.0.0", "message" : "string", "status" : "IMPORT_SUC CES S" } ] 状态码: 207 MULTI_STATUS [ { "source_app_id" : "328e5b04-f5f4-6528-3af1-a10790835f73", "destination_app_id" : "7513f7c2-eed5-4ebb-bd7d-cee85a87a338", "destination_app_name" : "dest_app_name", "version" : "1.0.0", "message" : "string", "status" : "IMPORT_SUCCESS" } ]
  • 请求参数 表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_apps 是 Array of AppSrcReq objects 源应用列表 数组长度:0 - 10 表4 AppSrcReq 参数 是否必选 参数类型 描述 destination_app_name 是 String 目标应用名称 取值范围:长度为[1,56],以大小写字母开头,允许出现中划线(-)、下划线(_)、小写字母和数字,且必须以大小写字母或数字结尾。 最小长度:1 最大长度:56 destination_app_version 是 String 目标应用版本 取值范围:长度[1,24],以小写字母或数字或大写字母开头,允许出现中划线,必须以小写字母或数字或大写字母结尾。 最小长度:1 最大长度:24 source_app_id 是 String 源应用id 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/batch-import 表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}/images/{image_id}/tags/{tag} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 image_id 是 String 镜像id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 tag 是 String 镜像版本名称 最小长度:1 最大长度:128
  • 请求示例 创建标签页,名称为脑科学,类型为TOOL,标签为labelA https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/label-pages { "name" : "脑科学", "feature" : "TOOL", "labels" : [ "labelA" ] }
  • URI POST /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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 标签页面标题,正则匹配中文,英文字母和数字及下划线 最小长度:1 最大长度:32 feature 是 String 标签页面类型 枚举值: TOOL labels 是 Array of strings 标签页面包含的标签值,正则匹配中文,英文字母和数字及下划线 最小长度:1 最大长度:32 数组长度:1 - 5
  • 请求示例 安装Nextflow,指定Nextflow版本为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/nextflow/engines { "version" : "1.0.0" } 安装Nextflow,上传本地名为test.txt的Nextflow文件 { "total_part" : 1, "part_number" : 1, "file_name" : "test.txt", "file" : "(binary)", "multipart_id" : "0000018615613ADF4014668067FBD6A7" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 FormData参数 参数 是否必选 参数类型 描述 file 否 File 文件流对象 part_number 否 Integer 分段序号,表示第几个文件片段 最小值:1 最大值:128 缺省值:1 total_part 否 Integer 分段总数,上传的文件总共分成了几个片段 最小值:1 最大值:128 缺省值:1 multipart_id 否 String 分段上传任务id,除了第一个片段外,后续的片段都需要标识出任务id 最小长度:1 最大长度:128 file_name 否 String 文件名称 最小长度:1 最大长度:100 version 否 String 版本号 最小长度:1 最大长度:50
  • 响应示例 状态码: 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
  • 请求参数 表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 } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 tasks Array of NextflowTaskListDto objects 子任务实例 count Integer 子任务的总数 表5 NextflowTaskListDto 参数 参数类型 描述 task_id String 子任务id process String 流程名称 tag String 子任务标识符 hash String 哈希值 status String 子任务状态 container String 容器名称 pod_name String pod名称 submit String 提交时间 complete String 完成时间 duration Long 总时间 realtime Long 实际运行时间 cpu_percent Double cpu使用率 mem_percent Double 内存使用率
  • 响应示例 状态码: 200 OK { "count" : 1, "tasks" : [ { "task_id" : "1", "process" : "convertToUpper", "tag" : "\"process_tag\"", "hash" : "45/39c703", "status" : "COMPLETED", "container" : "127.0.0.1:8080/hwofficial/coredns:1.23.2", "pod_name" : "nf-322decb1e97bfcaba3b6672b73551206", "submit" : 1675756197305, "complete" : 1675756199000, "duration" : 1695, "realtime" : 82, "cpu_percent" : 42.0, "mem_percent" : 32.0 } ] }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 search_key 否 String 模糊搜索值 最小长度:0 最大长度:1024
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 maximum ExtremumDto object study作业最值信息 minimum ExtremumDto object study作业最值信息 表4 ExtremumDto 参数 参数类型 描述 value Double 最值 row_number Long 最值所在的行数 column_name String 最值所在的列名 row_name String 最值所在的行名
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id}/jobs/{job_id}/extremum 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 study_id 是 String study_id 最小长度:1 最大长度:128 job_id 是 String study作业id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "maximum" : { "value" : 17, "row_number" : 102, "column_name" : "Mpro", "row_name" : "AZD-5991" }, "minimum" : { "value" : 17, "row_number" : 102, "column_name" : "Mpro", "row_name" : "AZD-5991" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 模板文件
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates/upload 表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参数 参数 是否必选 参数类型 描述 source_project_id 是 String 源项目ID 最小长度:1 最大长度:128 image_id 是 String 镜像ID 最小长度:1 最大长度:128 tag 是 String 镜像tag 最小长度:1 最大长度:128
  • 请求示例 导入镜像,选取指定项目中指定镜像的版本 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/images/import { "source_project_id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda", "image_id" : "f3db389c-a252-47f2-b94e-ffeffd3d72cb", "tag" : "v1.1" }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/images/import 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 data_job_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参数 参数 是否必选 参数类型 描述 action 是 String 操作 枚举值: RETRY CANCEL OFFLINE
  • URI POST /v1/{project_id}/assets/{asset_id}/versions/{version}/action 表1 路径参数 参数 是否必选 参数类型 描述 asset_id 是 String 资产id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 version 是 String version 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/instances/{instance_name}/metric-data 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 task_name 是 String 子任务名称 最小长度:1 最大长度:128 instance_name 是 String 子任务实例名称 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 task_index 否 String 子任务的并发序号 缺省值:0 最小长度:1 最大长度:128 from_time 否 Long 查询监控数据起始时间,UNIX时间戳,单位毫秒,不填时默认为当前时间 to_time 否 Long 查询监控数据截止时间,UNIX时间戳,单位毫秒,不填时默认为当前时间 method 否 String 统计方法。枚举值,取值范围:maximum(最大值)、minimum(最小值)、average(平均值),不填时默认为maximum 缺省值:maximum metric_name 是 String 查询的监控指标名称
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 complete_data Array of strings 已完成的数据列表 running_data Array of strings 正在执行的数据列表 creator String 数据作业创建者 source_project_id String 非本项目操作场景下源项目名称 source_project_name String 非本项目操作场景下源项目名称 id String 数据作业ID name String 数据作业名称 sources Array of strings 数据列表 create_time String 数据作业创建时间 end_time String 数据作业结束时间 status String 数据作业状态 destinations Array of strings 数据列表 type String 数据作业类型 failed_reason String 数据作业失败原因 additions String 附加信息
共100000条