华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限， 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 space 是 Integer 存储空间，单位GB 最小值：10240 最大值：327680 count 是 Integer 购买数量 最小值：1 最大值：10

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of PerformanceResourceRsp objects 性能加速资源列表 表4 PerformanceResourceRsp 参数 参数类型 描述 id String 实例ID resource_id String 资源ID name String 实例名称 spec SpecDto object 规格信息 availability_zone_id String 可用区 space Integer 最大容量，单位GB free_space Double 可用容量，单位GB charge_mode String 计费模式，取值范围： 1（包年包月） 2（按需） period_num Integer 购买周期 running_job_count Integer 作业运行数 job_quota Integer 在加速资源上，运行的最大作业数量 create_time String 购买时间 failure_reason String 失败原因 status String 状态 schedulable Boolean 资源是否可调度 表5 SpecDto 参数 参数类型 描述 code String 规格编号 最大长度：64 name String 规格名称 最大长度：64

响应示例 状态码： 200 OK { "count" : 1, "resources" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-.......", "name" : "instance", "spec" : { "code" : "code", "name" : "name" }, "availability_zone_id" : "cn-north-7c", "space" : 65, "free_space" : 30, "charge_mode" : 2, "period_num" : 1, "job_quota" : 8, "create_time" : "2021-02-01T14:25:50Z", "status" : "Deploying" } ] }

调用API获取项目ID 项目ID通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为GET“https://{Endpoint}/v3/projects”，其中{Endpoint}为 IAM 的终端节点，可以从地区和终端节点获取。 响应示例如下，例如 EIHealth 部署的区域为"cn-north-4"，响应消息体中查找“name”为"cn-north-4"，其中projects下的“id”即为项目ID。 GET https://{Endpoint}/v3/projectsX-Auth-Token:ABCDEFJ....{"projects": [{"domain_id": "65382450e8f64ac0870cd180d14e684b","is_domain": false,"parent_id": "65382450e8f64ac0870cd180d14e684b","name": "cn-north-4","description": "","links": {"next": null,"previous": null,"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"},"id": "a4a5d4098fb4474fa22cd05f897d6b99","enabled": true}],"links": {"next": null,"previous": null,"self": "https://www.example.com/v3/projects"}}

响应示例 状态码： 200 自定义属性任务查询成功响应 { "status" : "finished", "result" : { "id" : "3b2dce64-c244-11ed-acf5-0255ac100017", "prop_definition" : { "id" : null, "name" : "custom_prop_name", "type" : "binary", "description" : "custom_prop_description" }, "metrics" : [ { "name" : "rmsd", "value" : 0.73 } ] }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 异步任务的状态：等待中、运行中、已完成、失败 枚举值： waiting running finished failed task_data CustomPropsTaskData object 自定义属性任务的请求体 result CustomPropsResult object 自定义属性任务的返回结果 表4 CustomPropsTaskData 参数 参数类型 描述 name String 自定义属性名称 最小长度：1 最大长度：32 description String 自定义属性描述信息 最小长度：0 最大长度：256 type String 属性预测类型 枚举值： binary numerical smiles Array of strings 用于建模的smiles列表 values Array of numbers 用于建模的属性值列表 表5 CustomPropsResult 参数 参数类型 描述 id String 自定义属性ID（API侧） 最小长度：1 最大长度：64 prop_definition PropDefinition object 自定义属性元信息 metrics Array of CustomPropsModelMetric objects 自定义属性建模的评估指标集合 表6 PropDefinition 参数 参数类型 描述 id String 属性业务侧ID 最小长度：1 最大长度：128 name String 属性名称 最小长度：1 最大长度：32 type String 属性类型 枚举值： binary numerical description String 属性具体描述信息 最小长度：0 最大长度：256 value_range ValueRange object 属性有效值域区间 optimal_range ValueRange object 属性最优值域区间 warning_range ValueRange object 属性欠佳值域区间 style String 模型参数呈现类型 枚举值： number probability confidential_interval Boolean 模型推理是否呈现置信区间 表7 ValueRange 参数 参数类型 描述 lower Number 值域下限 lower_inclusive Boolean 是否包含值域下限 upper Number 值域上限 upper_inclusive Boolean 是否包含值域上限 表8 CustomPropsModelMetric 参数 参数类型 描述 name String 评估指标的名称 最小长度：1 最大长度：32 value Float 评估指标的评估结果

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 异步任务的状态：等待中、运行中、已完成、失败 枚举值： waiting running finished failed task_data SynthesisTaskData object 分子合成路径规划任务的请求体 result SynthesisResult object 分子合成路径规划任务的返回结果 表4 SynthesisTaskData 参数 参数类型 描述 smiles String 分子SMILES表达式 top_n Integer 期望最大返回条目数（排序后取TopN） 最小值：1 最大值：50 max_search_depth Integer 预测路径的最大深度 最小值：3 最大值：12 max_prediction_per_product Integer 每个产物的最大反应数量 最小值：2 最大值：20 表5 SynthesisResult 参数 参数类型 描述 smiles String 产物smiles序列 top_n Integer 期望返回的条目数 max_search_depth Integer 期望搜索的最大深度 max_prediction_per_product Integer 期望每个产物的最多反应数量 result result object 合成路径规划结果字典 表6 result 参数 参数类型 描述 molecules Array of molecules objects 分子合成规划中的分子 reactions Array of reactions objects 分子合成规划中的反应列表 synthesis_routes Array of SynthesisResultItem objects 分子合成规划的具体信息 表7 molecules 参数 参数类型 描述 id String molecule的序号 smiles String molecule的smiles序列 source String molecule的smiles来源 表8 reactions 参数 参数类型 描述 id String 反应的序号 reactants Array of strings 反应物分子序号的列表 product String 产物分子序号 表9 SynthesisResultItem 参数 参数类型 描述 route Array of strings 分子合成规划，列表内是reactions id score Float 当前分子合成路径的得分

响应示例 状态码： 200 分子合成路径规划任务查询成功响应 { "status" : "finished", "result" : { "smiles" : "c1ccccc1", "top_n" : 50, "max_search_depth" : 5, "max_prediction_per_product" : 20, "result" : { "molecules" : [ { "id" : "1", "smiles" : "c1ccccc1", "source" : "ZINC" }, { "id" : "2", "smiles" : "C11c", "source" : "ZINC" }, { "id" : "3", "smiles" : "C1c1", "source" : "ZINC" }, { "id" : "4", "smiles" : "c1", "source" : "ZINC" }, { "id" : "5", "smiles" : "cc", "source" : "ZINC" }, { "id" : "6", "smiles" : "Cc", "source" : "ZINC" }, { "id" : "7", "smiles" : "Cc1", "source" : "ZINC" } ], "reactions" : [ { "id" : "1", "reactants" : [ "2", "3" ], "product" : "1" }, { "id" : "2", "reactants" : [ "4", "5", "6" ], "product" : "2" }, { "id" : "3", "reactants" : [ "4", "7" ], "product" : "2" } ], "synthesis_routes" : [ { "route" : [ "1", "2" ], "score" : 0.3467 }, { "route" : [ "1", "3" ], "score" : 0.3154 } ] } }}

请求示例 创建自定义属性 POST https://{endpoint}/v1/{project_id}/custom-props{ "name" : "my_custom_prop", "description" : "my_custom_prop_description", "type" : "binary", "smiles" : [ "c1ccccc1", "c1ccccc1" ], "values" : [ 1, 0 ]}

响应示例 状态码： 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 } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户 token 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义属性名称 最小长度：1 最大长度：32 description 否 String 自定义属性描述信息 最小长度：0 最大长度：256 type 是 String 属性预测类型 枚举值： binary numerical smiles 是 Array of strings 用于建模的smiles列表 values 是 Array of numbers 用于建模的属性值列表

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体 平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 job_id 是 String 作业id 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 search_key 否 String 模糊搜索值 最小长度：0 最大长度：1024

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 tasks Array of 表5 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 { "id": "1", "command": "\n printf 'Hello World!' | split -b 6 - chunk_\n echo 'Hello World!'\n ", "status": "COMPLETED", "exit": 0, "work_dir": "/nextflow/__nextflow_work__/xxx/xxx", "module": [], "container": "100.79.1.xxx:xxx/official/coredns:1.23.2", "attempt": 1, "execution_time": { "submit": "2023-03-15T07:43:51Z", "start": "2023-03-15T07:43:52Z", "complete": "2023-03-15T07:43:54Z", "duration": 2445, "realtime": 588 }, "resource_requested": { "container": "100.79.1.xxx:xxx/official/coredns:1.23.2", "cpus": 1 }, "resource_usage": { "cpu_percent": 1.7, "mem_percent": 0, "rchar": 44191, "wchar": 244, "read_bytes": 4096, "write_bytes": 0, "vmem": 3735552, "rss": 2658304, "peak_vmem": 3735552, "peak_rss": 2658304, "syscr": 125, "syscw": 16, "vol_ctxt": 6, "inv_ctxt": 0 }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String task id command String task执行命令 status String task状态 error_action String task失败后的策略 exit Integer task退出状态码 work_dir String task执行路径 environment String task执行的环境变量值 module Array of strings 子任务运行环境列表 container String 容器名称 attempt Integer 执行次数 scratch String 临时工作目录 execution_time 表4 object task执行时间信息 resource_requested 表5 object task资源信息 resource_usage 表6 object task资源使用信息 表4 NextflowTaskExecutionTime 参数 参数类型 描述 submit String 提交时间 start String 开始时间 complete String 完成时间 duration Long 总时间 realtime Long 实际运行时间 表5 NextflowTaskResourceRequested 参数 参数类型 描述 container String 容器名称 queue String 执行队列，使用','分隔多个值 cpus Integer 指定task执行需要的cpu数量 memory String 指定task执行需要的内存大小 disk String 指定task执行需要的磁盘大小 time String 指定task执行需要的时间 表6 NextflowTaskResourceUsage 参数 参数类型 描述 cpu_percent Double cpu占用率 mem_percent Double 内存占用率 rchar Long 读取字符数 wchar Long 写入字符数 read_bytes Long 读取字节数 write_bytes Long 写入字符数 vmem Long process虚拟内存大小 rss Long process实际内存大小 peak_vmem Long process虚拟内存峰值 peak_rss Long process实际内存峰值 syscr Long 系统调用次数 读取类操作 syscw Long 系统调用次数 写入类操作 vol_ctxt Long 自愿上下文切换数 inv_ctxt Long 非自愿上下文切换数

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 job_id 是 String 作业id 最小长度：1 最大长度：128 task_id 是 String task id 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户 token 表3 请求Body参数 参数 是否必选 参数类型 描述 smiles 是 String 分子SMILES表达式 top_n 是 Integer 期望最大返回条目数（排序后取TopN） 最小值：1 最大值：50 max_search_depth 是 Integer 预测路径的最大深度 最小值：3 最大值：12 max_prediction_per_product 是 Integer 每个产物的最大反应数量 最小值：2 最大值：20

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/tasks/{task_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 job_id 是 String 作业id 最小长度：1 最大长度：128 task_id 是 String 任务id 最小长度：1 最大长度：128

响应示例 状态码： 200 OK { "count" : 1, "logs" : [ "Nextflow task log" ], "download_url" : "https://nextflow-xxx/__nextflow_run__/xxx-xxx-xxx/xx-xxxx-xxxxx/DAG.png?AccessKeyId=ABCDE&Expires=1676759470&Signature=DDDDD" }

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/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-fa163e3ddba1", "name" : "demo-workflow", "description" : "description", "labels" : [ "labelA", "labelB" ], "create_time" : "2021-01-30T02:34:36Z", "update_time" : "2021-01-30T02:53:26Z", "workflow_file" : "workflow.zip", "workflow_file_url" : "https://workflow.zip", "main_file" : "main.nf", "params_file" : "p1.yaml", "source_project_name" : "src", "source_resource_id" : "src-id", "params" : [ { "name" : "p1", "value" : "hello", "type" : "Other", "description" : "desc", "required" : true } ] }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 流程id name String 流程名称 description String 流程描述 labels Array of strings 流程标签 workflow_file String 流程的文件名 workflow_file_url String 流程的文件名下载地址 main_file String 主文件名 params_file String 用户上传时使用的参数文件名 params Array of 表4 objects 流程参数列表 create_time String 流程的创建时间 update_time String 流程的更新时间 source_project_name String 源项目名称 source_resource_id String 源资源id 表4 NextflowParamsDto 参数 参数类型 描述 name String 参数名 最小长度：1 最大长度：1024 value String 参数值 最小长度：0 最大长度：65535 type String 参数类型，取值范围：Other、File、Directory 最小长度：0 最大长度：20 description String 参数描述。取值范围：0-255 最小长度：0 最大长度：255 required Boolean 参数是否必填

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 FormData参数 参数 是否必选 参数类型 描述 workflow_file 否 File 流程文件。 文件大小：0-10M。 description 否 String 流程描述取值范围[0,65535] 最小长度：0 最大长度：65535 labels 否 Array of strings 流程标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。 最小长度：1 最大长度：32 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" }

响应示例 状态码： 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 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 workflows Array of 表5 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

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

请求示例 创建Nextflow流程，流程名为demo-workflow，流程主文件名为main.nf https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/workflows { "name" : "demo-workflow", "description" : "description", "labels" : [ "labelA", "labelB" ], "workflow_file" : "(binary)", "main_file" : "main.nf" }