华为云用户手册

  • 请求示例 创建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" }
  • 响应示例 状态码: 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中获取。
  • 响应示例 状态码: 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 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
  • 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 请求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
  • 请求示例 更新缩容策略,设置空闲时间为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 }
  • 响应参数 状态码: 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 查询的监控指标名称
  • 请求示例 导入用户,用户id为18c10a09-65d5-4fe8-...-4ce5570b8a4b,角色为ADMIN,作业配额为10,作业超时时长为1天,CPU的核数配额为50,内存的配额为128GB,用户可创建的项目数为2 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/batch-import { "iam_user_id" : "18c10a09-65d5-4fe8-...-4ce5570b8a4b", "role" : "ADMIN", "settings" : { "job_quota" : 10, "job_timeout" : 1, "cpu_quota" : 50, "mem_quota" : 128, "projects_per_user" : 2 } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 iam_user_id 是 String IAM 用户id 最小长度:1 最大长度:128 role 是 String 角色类型:管理员(ADMIN)、操作者(OPERATOR) 最小长度:1 最大长度:64 settings 否 表4 object 用户设置 表4 UserSettingDto 参数 是否必选 参数类型 描述 job_quota 是 Integer 允许同时运行的作业数 最小值:1 最大值:100 job_timeout 是 Integer 作业执行超时时长,单位天 最小值:1 最大值:60 cpu_quota 是 Integer 作业的CPU资源配额,单位核 最小值:1 最大值:1024 mem_quota 是 Integer 作业的内存资源配额,单位GB 最小值:1 最大值:1024 projects_per_user 否 Integer 用户可创建项目数配额 最小值:0 最大值:20 缺省值:2
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 通知消息总数 unread_count Integer 通知消息未读总数 notices Array of 表5objects 通知消息列表 表5 NoticeRsp 参数 参数类型 描述 id String 消息id type String 消息类型 detail String 消息详情 create_time String 消息创建时间 is_read Boolean 是否已读
  • URI GET /v1/{project_id}/notices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 表2 Query参数 参数 是否必选 参数类型 描述 is_read 否 Boolean 消息状态是否已读,true返回已读,false返回未读,不填返回全部 limit 否 Integer 查询条数 最小值:1 最大值:1000 缺省值:100 offset 否 Integer 查询偏移量 最小值:0 最大值:100000000 缺省值:0
  • 响应示例 状态码: 200 OK { "total_count" : 100, "unread_count" : 50, "notices" : [ { "id" : 123456, "type" : "RESOURCE", "is_read" : true, "detail" : "notice detail", "create_time" : "2022-11-24 09:33:56" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 notice_ids 是 Array of strings 批量删除通知消息id列表 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 notice_ids 是 Array of strings 批量更新通知消息id列表 最小长度:1 最大长度:128 operation 是 String 通知消息操作 枚举值: read
  • 请求示例 批量更新消息状态为已读 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/notices/batch-update { "notice_ids" : [ "baabcb56-5bb6-11eb-8a0d-......1", "baabcb56-5bb6-11eb-8a0d-......2" ], "operation" : "read" }
共100000条