华为云用户手册

  • 响应示例 状态码: 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 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" }
  • 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
  • 响应示例 状态码: 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
  • 请求示例 创建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" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 FormData参数 参数 是否必选 参数类型 描述 workflow_file 是 File 流程文件,文件大小[0,10M] name 是 String 流程名称,取值范围[1,56],允许大小写字母、数字、以及特殊字符中划线(-)和下划线(_)。更新流程时,流程名称不支持修改。 最小长度:1 最大长度:56 description 否 String 流程描述取值范围[0,65535] 最小长度:0 最大长度:65535 labels 否 Array of strings 流程标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 main_file 是 String 主文件名 最小长度:4 最大长度:1023 params 否 File 流程参数列表文件,取值范围[0, 10M]
  • 响应示例 状态码: 200 OK { "report_files" : [ { "name" : "DAG.png", "download_url" : "https://nextflow-xxxx/__nextflow_run__/xxx-xxx-xxx/xx-xxxx-xxxxx/DAG.png?AccessKeyId=ABCDE&Expires=1676759470&Signature=DDDDD" }, { "name" : "report.html", "download_url" : "https://xxx/__nextflow_run__/xxx-xxx-xxx/xx-xxxx-xxxxx/report.html?AccessKeyId=ABCDE&Expires=1676759470&Signature=DDDDD" } ] }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/reports 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 job_id 是 String 作业id 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/workflows 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 job_id 是 String 作业id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "count" : 1, "logs" : [ "Nextflow log" ], "download_url" : "https://nextflow-xxxx.obs.xxx/__nextflow_run__/xxx-xxx-xxx/xx-xxxx-xxxxx/DAG.png?AccessKeyId=ABCDE&Expires=1676759470&Signature=DDDDD" }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 job_id 是 String 作业id 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 FormData参数 参数 是否必选 参数类型 描述 params 否 File 流程参数列表文件,取值范围[0, 10M]
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/retry 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 job_id 是 String 作业id 最小长度:1 最大长度:128
  • URI DELETE /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中获取。 job_id 是 String 作业id 最小长度:1 最大长度:128
  • 请求示例 安装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。 表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
  • 请求示例 更新缩容策略,设置空闲时间为2分钟,扩容后多久再次判断缩容时间为5分钟 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/system/autoscaler/scale-in-policy { "idle_time" : 2, "threshold" : 50, "delay_after_add" : 5, "delay_after_delete" : 1, "delay_after_failure" : 1, "max_nodes_batch_deletion" : 1, "check_interval" : 1 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 idle_time 否 Integer 空置时间 最小值:1 最大值:10080 threshold 否 Integer 缩容阈值 最小值:1 最大值:100 delay_after_add 否 Integer 扩容后多久再次判断缩容 最小值:5 最大值:10080 delay_after_delete 否 Integer 节点删除后多久再次判断缩容 最小值:1 最大值:10080 delay_after_failure 否 Integer 缩容失败后多久再次判断缩容 最小值:1 最大值:10080 max_nodes_batch_deletion 否 Integer 缩容并发数 最小值:1 最大值:50 check_interval 否 Integer 检查间隔 最小值:1 最大值:10080
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 idle_time Integer 空置时间 threshold Integer 缩容阈值 delay_after_add Integer 扩容后多久再次判断缩容 delay_after_delete Integer 节点删除后多久再次判断缩容 delay_after_failure Integer 缩容失败后多久再次判断缩容 max_nodes_batch_deletion Integer 缩容并发数 check_interval Integer 检查间隔
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 策略名称 最小长度:1 最大长度:64 max_nodes 否 Integer 扩容节点数上限 最小值:1 最大值:50 min_nodes 否 Integer 扩容节点数下限 最小值:1 最大值:50 cpu_rule_enable 否 Boolean 是否启用cpu规则 cpu_percent 否 Integer cpu分配率百分比 最小值:1 最大值:100 add_nodes_for_cpu_rule 否 Integer 满足扩容策略中cpu分配率时增加的节点数 最小值:1 最大值:50 mem_rule_enable 否 Boolean 是否启用mem规则 mem_percent 否 Integer mem分配率百分比 最小值:1 最大值:100 add_nodes_for_mem_rule 否 Integer 满足扩容策略中mem分配率时增加的节点数 最小值:1 最大值:50
  • 请求示例 更新扩容策略配置,更改名称为strategy_4vCPUS_8GB https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/system/autoscaler/scale-out-policies/{id} { "name" : "strategy_4vCPUS_8GB", "max_nodes" : 50, "min_nodes" : 1, "cpu_rule_enable" : true, "cpu_percent" : 80, "add_nodes_for_cpu_rule" : 1, "mem_rule_enable" : true, "mem_percent" : 80, "add_nodes_for_mem_rule" : 1 }
  • 响应示例 状态码: 200 OK { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "strategy_4vCPUS_8GB", "status" : "normal", "create_time" : "2021-02-01T14:25:50Z", "node_spec" : { "code" : "eihealth.xxx.spec.xxx.xxx", "name" : "xxx", "ram" : 8192, "vcpus" : 4 }, "availability_zone" : "cn-north-7c", "nodes" : 1, "max_nodes" : 10, "min_nodes" : 0, "scaling_times" : 3, "scaling_enable" : true, "cpu_rule_enable" : true, "cpu_percent" : 80, "add_nodes_for_cpu_rule" : 1, "mem_rule_enable" : true, "mem_percent" : 80, "add_nodes_for_mem_rule" : 1 }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 策略ID name String 策略名称 status String 状态 create_time String 创建时间 node_spec NodeSpecDto object 节点规格信息 availability_zone String 可用区 nodes Integer 节点数量 max_nodes Integer 扩容节点数上限 min_nodes Integer 扩容节点数下限 scaling_times Integer 伸缩次数 scaling_enable Boolean 是否开启自动扩容 cpu_rule_enable Boolean 是否开启cpu执行策略 cpu_percent Integer cpu分配率百分比 add_nodes_for_cpu_rule Integer 满足扩容策略中cpu分配率时增加的节点数 mem_rule_enable Boolean 是否开启mem执行策略 mem_percent Integer mem分配率百分比 add_nodes_for_mem_rule Integer 满足扩容策略中mem分配率时增加的节点数 表4 NodeSpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64 ram Long 内存 vcpus String vcpus
  • 响应示例 状态码: 200 OK { "count" : 1, "policies" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-f.....", "name" : "strategy_4vCPUS_8GB", "status" : "normal", "create_time" : "2021-02-01T14:25:50Z", "node_spec" : { "code" : "eihealth.xxx.spec.xxx.xxx", "name" : "xxx", "ram" : 8192, "vcpus" : 4 }, "availability_zone" : "cn-north-7c", "nodes" : 1, "max_nodes" : 10, "min_nodes" : 0, "scaling_times" : 3, "scaling_enable" : true } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 policies Array of 表4 objects 计算资源列表 表4 ScaleOutPolicyRsp 参数 参数类型 描述 id String 策略ID name String 策略名称 status String 状态 create_time String 创建时间 node_spec 表5 object 节点规格信息 availability_zone String 可用区 nodes Integer 节点数量 max_nodes Integer 扩容节点数上限 min_nodes Integer 扩容节点数下限 scaling_times Integer 伸缩次数 scaling_enable Boolean 是否开启自动扩容 表5 NodeSpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64 ram Long 内存 vcpus String vcpus
  • 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,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 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 查询的监控指标名称
共100000条