华为云用户手册

  • 响应示例 状态码: 200 OK { "count" : 1, "assets" : [ { "id" : "aa78f595-5acb-4be8-b277-229be335626a", "category" : "WORKFLOW", "name" : "Docking Summary", "title" : "Docking Summary", "labels" : [ "molecular docking" ], "picture" : "https://eihealth.obs.cn-north-4.huawei.com:443/assets/metadata/picture.png", "vendor_id" : "00000000000000000000000000000000", "versions" : [ { "version" : "1.0.0", "publisher" : " EIHealth ", "description" : "", "summary" : "summary", "license" : "", "status" : "NORMAL", "labels" : [ "molecular docking", "drug discovery", "smallMolecularChemicals" ], "picture" : "data:image/png;base64,PD94b...", "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", "stars" : 1, "subscribes" : 1 } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 资产总数 assets Array of GetAssetRsp objects 资产列表 表4 GetAssetRsp 参数 参数类型 描述 id String 资产id category String 类别 name String 资产名 title String 资产展示名 labels Array of strings 资产标签列表 picture String 资产封面图访问链接 vendor_id String 供应商id versions Array of VersionRsp objects 资产版本号列表 create_time String 创建时间 update_time String 更新时间 stars Integer 收藏数 subscribes Integer 订阅数 表5 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 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of StorageResourceRsp objects 存储资源列表 表4 StorageResourceRsp 参数 参数类型 描述 spec SpecDto object 规格信息 size Long 使用量 charge_mode String 计费模式 create_time String 购买时间 status String 状态 表5 SpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64
  • 响应示例 状态码: 200 OK { "count" : 1, "resources" : [ { "spec" : { "code" : "code", "name" : "name" }, "size" : 1024, "charge_mode" : 2, "create_time" : "2021-02-01T14:25:50Z", "status" : "Deploying" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 资产名 最小长度:1 最大长度:128 version 是 String 版本号 最小长度:1 最大长度:64 title 否 String 展示名 最小长度:0 最大长度:128 summary 否 String 短描述 最小长度:0 最大长度:128 description 否 String 详细描述 最小长度:0 最大长度:65535 picture 否 String 封面图片base64编码 最小长度:0 最大长度:50000 labels 否 Array of strings 标签列表 最小长度:1 最大长度:32 数组长度:0 - 5 paths 是 Array of strings 路径列表 最小长度:1 最大长度:2000 数组长度:1 - 1
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/publish 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 请求示例 发布数据资产,数据资产名称为eihealth-asset,版本为1。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/publish { "name" : "eihealth-asset", "version" : "1", "title" : "title", "summary" : "this is summary", "description" : "this is description", "picture" : "data:image/png;base64,xxxxx", "labels" : [ "label1" ], "paths" : [ "test:/rootFolder/aaa.txt" ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportAppRsp objects OK 表6 ImportAppRsp 参数 参数类型 描述 source_app_id String 源应用id destination_app_id String 目标应用id destination_app_name String 目标应用名称 version String 应用版本 message String 导入结果信息,仅在导入失败时会返回 status String 导入结果状态 状态码: 207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportAppRsp objects MULTI_STATUS 表8 ImportAppRsp 参数 参数类型 描述 source_app_id String 源应用id destination_app_id String 目标应用id destination_app_name String 目标应用名称 version String 应用版本 message String 导入结果信息,仅在导入失败时会返回 status String 导入结果状态
  • 请求示例 导入应用,导入后应用名称为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
  • 响应示例 状态码: 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 } ] }
  • 响应参数 状态码: 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 内存使用率
  • 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
  • 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" } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 maximum ExtremumDto object study作业最值信息 minimum ExtremumDto object study作业最值信息 表4 ExtremumDto 参数 参数类型 描述 value Double 最值 row_number Long 最值所在的行数 column_name String 最值所在的列名 row_name String 最值所在的行名
  • 请求参数 表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
  • 请求示例 导入镜像,选取指定项目中指定镜像的版本 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" }
  • 请求参数 表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
  • 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
共100000条