华为云用户手册

  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体 平台项目ID,您可以在 EIHealth 平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求示例 更新流程,更新流程的cpu资源为1C,内存资源为1G https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/workflows { "name" : "demo-workflow", "version" : "1.0.0", "summary" : "summary", "description" : "description", "labels" : [ "labelA", "labelB" ], "timeout" : 1440, "output_dir" : "/workflow", "tasks" : [ { "task_name" : "app1-1", "app_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "display_name" : "步骤1", "output_dir" : "/task", "resources" : { "cpu_type" : "X86", "cpu" : "1C", "memory" : "1G", "gpu_type" : "GPU", "gpu" : 0 }, "location" : { "x" : 100, "y" : 100 }, "inputs" : [ { "name" : "dir-parameter", "values" : [ "/test" ] } ] } ] }
  • URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/workflows/{workflow_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 workflow_id 是 String 流程id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "id" : "baabcb56-5bb6-11eb-8a0d-fa163exxx", "name" : "demo-job", "description" : "description", "labels" : [ "labelA", "labelB" ], "status" : "COMPLETED", "has_ignore_failed_tasks" : false, "create_time" : "2021-01-30T02:53:26Z", "finish_time" : "2021-01-30T02:53:26Z", "workflow_name" : "demo-workflow", "workflow_id" : "56e0f1b0-ac10-46a5-8fa7-b26831dxxx", "command_line" : "nextflow run main.nf", "params" : [ { "name" : "p1", "value" : "hello", "type" : "Other", "description" : "desc", "required" : true } ], "config_files" : [ "nextflow.config" ], "config_context" : "config content" }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "dev_user_pool" : false, "has_dev" : false, "has_drug" : false, "has_encryption_button" : false, "deploy_mode" : "basic", "enable_cold_archive" : true, "public_bucket_path" : "https://bucket.obs.xxxx.myhuawei.com" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 dev_user_pool Boolean notebook是否使用专属资源池 has_dev Boolean 是否 集成开发环境 has_drug Boolean 是否部署药物虚拟筛选 has_encryption_button Boolean 是否显示加密按钮 deploy_mode String 医疗智能体平台部署模式 enable_cold_archive Boolean 是否支持归档类型存储 public_bucket_path String 医疗智能体公共数据桶https路径
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求示例 创建应用,应用名称为test-icon,版本为1.0.0 https:///eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps { "name": "test-icon", "version": "1.0.0", "summary": "summary", "description": "description", "labels": [ ], "image": "test-01/busybox:latest", "commands": [ "echo eihealth;" ], "resources": { "cpu_type": "X86", "cpu": "1C", "memory": "1G", "gpu_type": "GPU", "gpu": 0 }, "inputs": [ { "name": "dir-parameter", "description": "parameter description", "required": true, "concurrent": "vars_iter", "type": "DIRECTORY", "pattern": "*.fastq", "values": [ "" ] } ], "outputs": [ { "name": "dir-parameter1", "description": "parameter description", "required": true, "type": "DIRECTORY", "pattern": "*.fastq", "values": [ "/test" ] } ], "node_labels": [ "health.xxx" ], "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgd2lkdGg9IjExNnB4IiBoZWlnaHQ9IjExNnB4IiB2aWV3Qm94PSIwIDAgMTE2IDExNiIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIj4NCiAgICA8IS0tIEdlbmVyYXRvcjogU2tldGNoIDU2LjMgKDgxNzE2KSAtIGh0dHBzOi8vc2tldGNoLmNvbSAtLT4NCiAgICA8dGl0bGU+d29ya2Zsb3c8L3RpdGxlPg0KICAgIDxkZXNjPkNyZWF0ZWQgd2l0aCBTa2V0Y2guPC9kZXNjPg0KICAgIDxnIGlkPSLpobXpnaItMSIgc3Ryb2tlPSJub25lIiBzdHJva2Utd2lkdGg9IjEiIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCI+DQogICAgICAgIDxnIGlkPSJJY29uIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgtOTA5LjAwMDAwMCwgLTQ2OC4wMDAwMDApIj4NCiAgICAgICAgICAgIDxwYXRoIGQ9Ik05NjcsNDY4IEM5OTkuMDMyNTE1LDQ2OCAxMDI1LDQ5My45Njc0ODUgMTAyNSw1MjYgQzEwMjUsNTU4LjAzMjUxNSA5OTkuMDMyNTE1LDU4NCA5NjcsNTg0IEM5MzQuOTY3NDg1LDU4NCA5MDksNTU4LjAzMjUxNSA5MDksNTI2IEM5MDksNDkzLjk2NzQ4NSA5MzQuOTY3NDg1LDQ2OCA5NjcsNDY4IFoiIGlkPSLnn6nlvaIiIGZpbGw9IiNFRkY1RjciPjwvcGF0aD4NCiAgICAgICAgICAgIDxwYXRoIGQ9Ik05NTQuNTgxMjIzLDUzNi42OTA2NjcgQzk1NC45Mzg0OTEsNTM2LjY5MDY2NyA5NTUuMjY3ODQ5LDUzNi40OTc1MzQgOTU1LjQ0MjI4Nyw1MzYuMTg1NzQ2IEw5NjUuMTM2NDUzLDUxOC44NTg1NjMgQzk2Ni4wMTgwNzQsNTE3LjI4Mjc2OSA5NjcuNjgyNjY2LDUxNi4zMDY2NjcgOTY5LjQ4ODMxOSw1MTYuMzA2NjY3IEw5NzguODU2NDEyLDUxNi4zMDY2NjcgQzk3OS43MjY3MTYsNTEzLjIzMzg4IDk4Mi41NTI0NTksNTEwLjk4MjY2NyA5ODUuOTA0LDUxMC45ODI2NjcgQzk4OS45NDg5MzQsNTEwLjk4MjY2NyA5OTMuMjI4LDUxNC4yNjE3MzMgOTkzLjIyOCw1MTguMzA2NjY3IEM5OTMuMjI4LDUyMi4zNTE2IDk4OS45NDg5MzQsNTI1LjYzMDY2NyA5ODUuOTA0LDUyNS42MzA2NjcgQzk4Mi41NTI0NTksNTI1LjYzMDY2NyA5NzkuNzI2NzE2LDUyMy4zNzk0NTMgOTc4Ljg1NjQxMiw1MjAuMzA2NjY3IEw5NjkuNDg4MzE5LDUyMC4zMDY2NjcgQzk2OS4xMzEwNTEsNTIwLjMwNjY2NyA5NjguODAxNjkzLDUyMC40OTk3OTkgOTY4LjYyNzI1NCw1MjAuODExNTg3IEw5NTkuNzQzMjcsNTM2LjY5MDY2NyBMOTc4Ljg1NjQxMiw1MzYuNjkwNjY3IEM5NzkuNzI2NzE2LDUzMy42MTc4OCA5ODIuNTUyNDU5LDUzMS4zNjY2NjcgOTg1LjkwNCw1MzEuMzY2NjY3IEM5ODkuOTQ4OTM0LDUzMS4zNjY2NjcgOTkzLjIyOCw1MzQuNjQ1NzMzIDk5My4yMjgsNTM4LjY5MDY2NyBDOTkzLjIyOCw1NDIuNzM1NiA5ODkuOTQ4OTM0LDU0Ni4wMTQ2NjcgOTg1LjkwNCw1NDYuMDE0NjY3IEM5ODIuNTUyNDU5LDU0Ni4wMTQ2NjcgOTc5LjcyNjcxNiw1NDMuNzYzNDUzIDk3OC44NTY0MTIsNTQwLjY5MDY2NyBMOTUxLjM1MTU4OCw1NDAuNjkwNjY3IEM5NTAuNDgxMjg0LDU0My43NjM0NTMgOTQ3LjY1NTU0MSw1NDYuMDE0NjY3IDk0NC4zMDQsNTQ2LjAxNDY2NyBDOTQwLjI1OTA2Niw1NDYuMDE0NjY3IDkzNi45OCw1NDIuNzM1NiA5MzYuOTgsNTM4LjY5MDY2NyBDOTM2Ljk4LDUzNC42NDU3MzMgOTQwLjI1OTA2Niw1MzEuMzY2NjY3IDk0NC4zMDQsNTMxLjM2NjY2NyBDOTQ3LjY1NTU0MSw1MzEuMzY2NjY3IDk1MC40ODEyODQsNTMzLjYxNzg4IDk1MS4zNTE1ODgsNTM2LjY5MDY2NyBMOTU0LjU4MTIyMyw1MzYuNjkwNjY3IFogTTk0NC4zMDQsNTQzLjAxNDY2NyBDOTQ2LjY5MjA3OSw1NDMuMDE0NjY3IDk0OC42MjgsNTQxLjA3ODc0NiA5NDguNjI4LDUzOC42OTA2NjcgQzk0OC42MjgsNTM2LjMwMjU4NyA5NDYuNjkyMDc5LDUzNC4zNjY2NjcgOTQ0LjMwNCw1MzQuMzY2NjY3IEM5NDEuOTE1OTIxLDUzNC4zNjY2NjcgOTM5Ljk4LDUzNi4zMDI1ODcgOTM5Ljk4LDUzOC42OTA2NjcgQzkzOS45OCw1NDEuMDc4NzQ2IDk0MS45MTU5MjEsNTQzLjAxNDY2NyA5NDQuMzA0LDU0My4wMTQ2NjcgWiBNOTg1LjkwNCw1NDMuMDE0NjY3IEM5ODguMjkyMDc5LDU0My4wMTQ2NjcgOTkwLjIyOCw1NDEuMDc4NzQ2IDk5MC4yMjgsNTM4LjY5MDY2NyBDOTkwLjIyOCw1MzYuMzAyNTg3IDk4OC4yOTIwNzksNTM0LjM2NjY2NyA5ODUuOTA0LDUzNC4zNjY2NjcgQzk4My41MTU5MjEsNTM0LjM2NjY2NyA5ODEuNTgsNTM2LjMwMjU4NyA5ODEuNTgsNTM4LjY5MDY2NyBDOTgxLjU4LDU0MS4wNzg3NDYgOTgzLjUxNTkyMSw1NDMuMDE0NjY3IDk4NS45MDQsNTQzLjAxNDY2NyBaIE05ODUuOTA0LDUyMi42MzA2NjcgQzk4OC4yOTIwNzksNTIyLjYzMDY2NyA5OTAuMjI4LDUyMC42OTQ3NDYgOTkwLjIyOCw1MTguMzA2NjY3IEM5OTAuMjI4LDUxNS45MTg1ODcgOTg4LjI5MjA3OSw1MTMuOTgyNjY3IDk4NS45MDQsNTEzLjk4MjY2NyBDOTgzLjUxNTkyMSw1MTMuOTgyNjY3IDk4MS41OCw1MTUuOTE4NTg3IDk4MS41OCw1MTguMzA2NjY3IEM5ODEuNTgsNTIwLjY5NDc0NiA5ODMuNTE1OTIxLDUyMi42MzA2NjcgOTg1LjkwNCw1MjIuNjMwNjY3IFoiIGlkPSLlvaLnirbnu5PlkIgiIGZpbGw9IiMwODlCQUIiIGZpbGwtcnVsZT0ibm9uemVybyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoOTY1LjEwNDAwMCwgNTI4LjQ5ODY2Nykgc2NhbGUoMSwgLTEpIHRyYW5zbGF0ZSgtOTY1LjEwNDAwMCwgLTUyOC40OTg2NjcpICI+PC9wYXRoPg0KICAgICAgICA8L2c+DQogICAgPC9nPg0KPC9zdmc+" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 X-Addition-Info 否 String 设置为 LOG 时,返回作业日志链接
  • 响应示例 状态码: 200 OK { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "description" : "description", "labels" : [ "labelA", "labelB" ], "priority" : 0, "timeout" : 1440, "output_dir" : "/job/task", "status" : "SUCCEEDED", "create_time" : "2021-01-30T02:53:26Z", "finish_time" : "2021-01-30T02:53:26Z", "tool_info" : { "tool_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "tool_name" : "demo-workflow", "tool_version" : "1.0.0", "tool_type" : "workflow" }, "tasks" : [ { "task_name" : "app1-1", "display_name" : "步骤1", "output_dir" : "/task", "whole_output_dir" : "/workflow/task", "io_acc_type" : "SFS", "resources" : { "cpu_type" : "X86", "cpu" : "1C", "memory" : "1G", "gpu_type" : "GPU", "gpu" : 0 }, "location" : { "x" : 100, "y" : 100 }, "inputs" : [ { "name" : "dir-parameter", "values" : [ "/test" ] } ], "app_info" : { "app_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "app_name" : "demo-app", "app_version" : "1.0.0", "app_labels" : [ "labelA", "labelB" ], "app_summary" : "summary", "app_description" : "description", "app_image" : "gwj-test-01/busybox:latest", "app_commands" : [ "echo eihealth;" ], "app_input_parameters" : [ { "name" : "dir-parameter", "description" : "parameter description", "required" : true, "type" : "DIRECTORY", "pattern" : "*.fastq", "values" : [ "/test" ], "enum" : [ "/test" ] } ], "app_output_parameters" : [ { "name" : "dir-parameter", "description" : "parameter description", "required" : true, "type" : "DIRECTORY", "pattern" : "*.fastq", "values" : [ "/test" ] } ] } } ], "task_runtime_info" : [ { "task_name" : "app1-1", "create_time" : "2021-01-30T02:53:26Z", "finish_time" : "2021-01-30T02:53:26Z", "actual_running_time" : 100, "status" : "SUCCEEDED", "sub_tasks" : [ { "sub_task_name" : "app1-1-0", "create_time" : "2021-01-30T02:53:26Z", "finish_time" : "2021-01-30T02:53:26Z", "actual_running_time" : 100, "status" : "SUCCEEDED", "pod_create_time" : "2021-01-30T02:53:26Z", "pod_start_time" : "2021-01-30T02:53:26Z", "job_failed_times" : 0 } ] } ], "dag" : { "app1-1" : { } } }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 响应示例 状态码: 200 OK { "id": "dc1988c3-a684-11ec-8c0a-fa163edb6ab8", "name": "demo-app-api1", "version": "123456789012345", "summary": "summary", "description": "description", "labels": [], "image": " gwj-test-01/busybox:latest ", "commands": [ "echo eihealth;" ], "resources": { "cpu_type": "X86", "cpu": "1C", "memory": "1G", "gpu_type": "GPU", "gpu": "0" }, "inputs": [ { "enum": [], "name": "dir-parameter", "description": "parameter description", "required": true, "concurrent": "", "type": "DIRECTORY", "pattern": "*.fastq", "values": [] } ], "outputs": [ { "enum": [], "name": "dir-parameter1", "description": "parameter description", "required": true, "type": "DIRECTORY", "pattern": "*.fastq", "values": [ "/test" ] } ], "create_time": "2022-03-18T06:30:10Z", "update_time": "2022-03-26T02:25:19Z", "user_name": "gwj-test-01", "source_project_name": "", "source_resource_id": "", "node_labels": [ "health.q12334567890123451" ], "icon": "data:image/svg+xml;base64,77u/PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxzdmcgdmVyc2lvbj0iMS4xIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgd2lkdGg9IjE2cHgiIGhlaWdodD0iMTVweCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4NCiAgPGcgdHJhbnNmb3JtPSJtYXRyaXgoMSAwIDAgMSAtNDMzIC0yMTcgKSI+DQogICAgPHBhdGggZD0iTSAxNC42IDIgIEwgMS40IDIgIEwgMS40IDEwICBMIDE0LjYgMTAgIEwgMTQuNiAyICBaIE0gMCAxLjQgIEMgMCAwLjggIDAuNCAwLjQgIDEgMC40ICBMIDE1IDAuNCAgQyAxNS42IDAuNCAgMTYgMC44ICAxNiAxLjQgIEwgMTYgMTAuNCAgQyAxNiAxMSAgMTUuNiAxMS40ICAxNSAxMS40ICBMIDEgMTEuNCAgQyAwLjQgMTEuNCAgMCAxMSAgMCAxMC40ICBMIDAgMS40ICBaIE0gMTIgMTQuNSAgTCA0LjMgMTQuNSAgQyAzLjkgMTQuNSAgMy42IDE0LjIgIDMuNiAxMy44ICBDIDMuNiAxMy40ICAzLjkgMTMuMSAgNC4zIDEzLjEgIEwgMTIgMTMuMSAgQyAxMi40IDEzLjEgIDEyLjcgMTMuNCAgMTIuNyAxMy44ICBDIDEyLjcgMTQuMiAgMTIuNCAxNC41ICAxMiAxNC41ICBaIE0gNS42IDYuNyAgTCA1LjMgNy4yICBDIDUuMiA3LjQgIDUgNy41ICA0LjkgNy41ICBMIDMuNiA3LjUgIEMgMy4zIDcuNSAgMy4xIDcuMyAgMy4xIDcgIEMgMy4xIDYuNyAgMy4zIDYuNSAgMy42IDYuNSAgTCA0LjYgNi41ICBMIDUuMyA1LjQgIEMgNS41IDUgIDYgNS4xICA2LjIgNS41ICBMIDYuOSA3LjMgIEwgOC42IDIuNiAgQyA4LjcgMi4yICA5LjMgMi4yICA5LjUgMi41ICBMIDExLjUgNi41ICBMIDEyLjQgNi41ICBDIDEyLjcgNi41ICAxMi45IDYuNyAgMTIuOSA3ICBDIDEyLjkgNy4zICAxMi43IDcuNSAgMTIuNCA3LjUgIEwgMTEuMiA3LjUgIEMgMTEgNy41ICAxMC44IDcuNCAgMTAuOCA3LjIgIEwgOS4xIDQgIEwgNy4zIDguOSAgQyA3LjEgOS4zICA2LjUgOS4zICA2LjQgOC45ICBMIDUuNiA2LjcgIFogIiBmaWxsLXJ1bGU9Im5vbnplcm8iIGZpbGw9IiM1NzVkNmMiIHN0cm9rZT0ibm9uZSIgdHJhbnNmb3JtPSJtYXRyaXgoMSAwIDAgMSA0MzMgMjE3ICkiIC8+DQogIDwvZz4NCjwvc3ZnPg==" }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id 最小长度:1 最大长度:128 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs/{auto_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 auto_job_id 是 String 自动作业id。 最小长度:1 最大长度:128
  • 请求示例 更新自动作业,更新自动作业的名称为demo-auto-job,使用的数据库列为user_name https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs { "name" : "demo-auto-job", "description" : "description", "database_id" : "2adc4b5fbeeb4a518f177167074a5fb2", "database_column" : "user_name", "database_column_type" : "NEW", "clean_database_column" : false, "database_trigger" : [ { "name" : "status", "judge_mode" : "gte", "value" : "100" } ], "tool_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "tool_type" : "workflow", "job_name" : "demo-job", "job_name_type" : "AUTO", "job_description" : "description", "labels" : [ "labelA", "labelB" ], "priority" : 0, "timeout" : 1440, "output_dir" : "/job", "output_dir_type" : "MANUAL", "node_labels" : [ "health.node" ], "io_acc_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "tasks" : [ { "task_name" : "app1-1", "inputs" : [ { "name" : "dir-parameter", "source" : "MANUAL", "values" : [ "/test" ] } ], "resources" : { "cpu" : "1C", "cpu_type" : "X86", "memory" : "1G", "gpu_type" : "GPU", "gpu" : "0" }, "io_acc_type" : "SFS" } ] }
  • 请求示例 文件下载,其中文件类型为PUBLIC,文件链接如下。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/data/download { "type" : "PUBLIC", "url" : "https://eihealth-6a713322-72ad-4080-bdcb-acf571576015.obs.xxx.myhuaweicloud.com/test.txt" } { "type" : "PRIVATE", "url" : "projectName:/test.txt" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 type 否 String 下载类型(仅支持PRIVATE|PUBLIC) 枚举值: PRIVATE PUBLIC url 否 String 资源地址(支持https、obs地址) 最小长度:1 最大长度:2000
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data/download 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看。 最小长度: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 创建药物作业基本信息 receptor 是 ReceptorDrugFile object 受体文件 ligands 是 Array of LigandPreviewDto objects 配体列表 数组长度:2 - 101 graph 是 FepGraphDto object 路径图 params 是 FepParamDto object FEP设置参数 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称,取值范围:[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头 最小长度:5 最大长度:64 labels 否 Array of strings 标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5 表5 ReceptorDrugFile 参数 是否必选 参数类型 描述 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 表6 LigandPreviewDto 参数 是否必选 参数类型 描述 index 是 Integer 配体索引(从0起编号) 最小值:0 最大值:99 file 是 DrugFile object 配体文件 name 是 String 配体名称,若无名称则自动命名,格式为UNK+索引(从1起编号) 最小长度:1 最大长度:32 smiles 是 String 分子SMILES表达式 最小长度:1 最大长度:512 表7 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 表8 FepGraphDto 参数 是否必选 参数类型 描述 center_id 是 String 中心配体名称 最小长度:1 最大长度:32 pairs 是 Array of SimilarityDto objects 配体对列表 数组长度:1 - 100 表9 SimilarityDto 参数 是否必选 参数类型 描述 ligand_ids 是 Array of strings 配体对 最小长度:1 最大长度:32 数组长度:2 - 2 表10 FepParamDto 参数 是否必选 参数类型 描述 num_pre_equilibrium_steps 否 Integer 预平衡步数 最小值:5000 最大值:50000 缺省值:50000 num_equilibrium_steps 否 Integer 平衡步数 最小值:5000 最大值:500000 缺省值:500000 timestep_size 否 Float 时间步长,取值范围:大于等于0.001,小于等于0.005 最小值:0.001 最大值:0.005 缺省值:0.002 num_lambda 否 Integer lambda个数 最小值:2 最大值:30 缺省值:20
  • 请求示例 创建自由能微扰作业,作业名称为demo-job,受体文件为project:/dir/file,配体分别为GLY:A:514和UNK1,路径图的中心配体为GLY:A:514,配体对分别为GLY:A:514和DrugBank:UNK1,预平衡步数为50000,平衡步数为500000,时间步长为0.002,lambda的个数为20 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/fep { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "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 } }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/fep 表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参数 参数 是否必选 参数类型 描述 mode 是 String 创建配体相似度图的模式:中心模式、自由模式 枚举值: CENTER FREE ligands 是 Array of CreateLigandSimilarityGraphLigandDto objects 配体列表 数组长度:2 - 101 表4 CreateLigandSimilarityGraphLigandDto 参数 是否必选 参数类型 描述 name 是 String 配体分子唯一名字,受体中的建议使用"{氨基酸}:{链}:{编号}" 最小长度:1 最大长度:32 smiles 是 String 分子SMILES表达式 最小长度:1 最大长度:512 main 否 Boolean 配体是否为主要配体,在中心模式下,必须指定1个主要配体 缺省值:false
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/similarity-graph 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/{job_id}/cancel 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128
  • 请求示例 创建分子优化作业,作业名称为demo-job,分子SMILES表达式为string,靶点设置的受体文件为project:/test.pdb,口袋中心位置为[0,0,0],口袋尺寸大小为[500,500,500],设置弱约束为cs1类型为布尔值,值为true,设置强约束为cs2,类型为range,值为[0,1] https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/optimization { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "smiles" : "string", "num_trials" : 500, "binding_site" : { "receptor" : { "source" : "PRIVATE", "url" : "project:/test.pdb" }, "bounding_box" : { "center" : [ 0, 0, 0 ], "size" : [ 500, 500, 500 ] }, "remove_ion" : false, "remove_water" : false, "remove_ligand" : false }, "weak_constraints" : [ { "name" : "cs1", "type" : "bool", "bool" : true } ], "strong_constraints" : [ { "name" : "cs2", "type" : "range", "range" : [ 0, 1 ] } ] }
  • 请求参数 表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 molecule_file 否 DrugFile object 分子文件 binding_site 否 BindSiteDto object 受体 weak_constraints 否 Array of WeakConstraintDto objects 弱约束集合 数组长度:0 - 16 strong_constraints 否 Array of StrongConstraintDto objects 强约束集合 数组长度:0 - 4 sampler_mixin_weight 否 Float 初始化采样权重,参数范围(0.5, 1),不包含0.5和1,默认为0.6 最小值:0.5 最大值:1 缺省值:0.6 model_ids 否 Array of strings 模型id列表 最小长度:1 最大长度:128 数组长度:0 - 10 num_trials 否 Integer 生成分子数量 最小值:0 最大值:5000 缺省值:5000 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称,取值范围:[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头 最小长度:5 最大长度:64 labels 否 Array of strings 标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5 表5 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 表6 BindSiteDto 参数 是否必选 参数类型 描述 receptor 是 ReceptorDrugFile object 受体文件 bounding_box 否 BoundingBoxDto object 结合口袋,包含口袋中心位置和尺寸大小 remove_ion 否 Boolean 去除受体中的离子 缺省值:true remove_water 否 Boolean 去除受体中的水分子 缺省值:true remove_ligand 否 Boolean 去除受体中的配体分子 缺省值:true 表7 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 表8 BoundingBoxDto 参数 是否必选 参数类型 描述 center 是 Array of numbers 口袋中心坐标; x, y, z轴的坐标 数组长度:3 - 3 size 是 Array of numbers 口袋尺寸大小; x, y, z轴的大小 最小值:2 最大值:500 数组长度:3 - 3 padding 否 Integer 填充 最小值:0 最大值:20 表9 WeakConstraintDto 参数 是否必选 参数类型 描述 id 否 String 自定义模型id,仅弱约束为模型时填写 最小长度:1 最大长度:128 name 否 String 属性名称 最小长度:1 最大长度:128 type 是 String 属性约束类型 枚举值: bool range struct minimize maximize bool 否 Boolean 属性约束类型bool的参数 range 否 Array of numbers 属性约束类型range的参数 数组长度:2 - 2 struct 否 StructureConstraintParamsDto object 结构约束参数 quantiles 否 Array of numbers 属性约束类型minimize和maximize的参数 最小值:0.0 最大值:1.0 数组长度:2 - 2 表10 StrongConstraintDto 参数 是否必选 参数类型 描述 id 否 String 自定义模型id,仅强约束为模型时填写 最小长度:1 最大长度:128 name 否 String 属性名称 最小长度:1 最大长度:128 type 是 String 属性约束类型 枚举值: bool range struct bool 否 Boolean 属性约束类型bool的参数 range 否 Array of numbers 属性约束类型range的参数 数组长度:2 - 2 struct 否 StructureConstraintParamsDto object 结构约束参数 表11 StructureConstraintParamsDto 参数 是否必选 参数类型 描述 structs 是 Array of strings 子结构SMILES 最小长度:1 最大长度:120 数组长度:1 - 8 exclusive 是 Boolean 是否排除子结构 operator 否 String 多个子结构之间的逻辑关系 枚举值: or and
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/optimization 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "basic_info" : { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "labels" : [ "labelA", "labelB" ], "status" : "FINISHED", "type" : "ADMET", "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 }, "molecule_file" : { "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "count" : 1000 }, "job_result" : { "total_count" : 10, "failed_count" : 1 } }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/admet/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128
共100000条