华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限， 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作 枚举值： RETRY CANCEL OFFLINE

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 iam_user_id 是 String IAM 用户id 最小长度：1 最大长度：128 role 是 String 角色类型：管理员(ADMIN)、操作者(OPERATOR) 最小长度：1 最大长度：64 settings 否 UserSettingDto 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参数 参数 参数类型 描述 apps Array of AppListDto objects 应用列表 count Integer 应用总条数 表5 AppListDto 参数 参数类型 描述 id String 应用id name String 应用名称 version String 应用版本 summary String 应用简述 description String 应用描述 labels Array of strings 应用标签 create_time String 创建应用时间 update_time String 更新应用时间 user_name String 创建应用的用户名 source_project_name String 源项目名称 source_resource_id String 源资源id icon String 图标base64编码

响应示例 状态码： 200 OK { "apps" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-app", "version" : "1.0.0", "summary" : "summary", "description" : "description", "labels" : [ "labelA", "labelB" ], "create_time" : "2021-01-30T02:34:36Z", "update_time" : "2021-01-30T02:53:26Z", "user_name" : "gwj-test-01" } ], "count" : 1}

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

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/import-from-network 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 target_folder 否 String 所在文件夹 最小长度：0 最大长度：2000 urls 是 Array of strings 导入网上数据的url集 最小长度：0 最大长度：4096 数组长度：1 - 10 md5s 否 Array of strings 导入网上数据的md5集 最小长度：0 最大长度：4096 数组长度：1 - 10

请求示例 导入网上数据，数据链接为https://www.hhh.com/test.txt，目的目录为test。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/import-from-network{ "target_folder" : "test/", "urls" : [ "https://www.hhh.com/test.txt" ]}

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 应用名称 最小长度：1 最大长度：56 version 否 String 应用版本 最小长度：1 最大长度：32

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 项目描述 最小长度：0 最大长度：1024 name 是 String 项目名称 最小长度：3 最大长度：45 tags 否 Array of strings 标签 最小长度：1 最大长度：32 数组长度：0 - 5 is_core 否 Boolean 是否核心项目 缺省值：true is_new_bucket 否 Boolean 是否新桶, 仅气象支持该字段 bucket_name 否 String 桶名, 仅气象支持该字段 最小长度：3 最大长度：63

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 用户名，长度1~64之间，首位不能为数字，特殊字符只能包含下划线“_”、中划线“-”和空格 最小长度：1 最大长度：64 password 是 String 用户密码，在8-32位之间支持用户自定义密码长度，至少包含以下四种字符中的两种： 大写字母、小写字母、数字和特殊字符。 最小长度：8 最大长度：32 role 是 String 角色类型：管理员(ADMIN)、操作者(OPERATOR) 最小长度：1 最大长度：64 email 否 String 用户邮箱，需符合邮箱格式 最小长度：0 最大长度：128 phone 否 String 用户手机号，纯数字，长度小于等于32位。必须与国家码同时存在。 最小长度：5 最大长度：32 areacode 否 String 国家码。中国大陆为“0086” 最小长度：1 最大长度：10 settings 否 UserSettingDto 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

请求示例 创建用户，用户名为example_user，密码为example，角色为ADMIN，邮箱为example@huawei.com，电话为12345678910，作业配额为10，作业超时时长为1天，CPU的核数配额为50，内存的配额为128GB，用户可创建的项目数为2 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users{ "name" : "example_user", "password" : "example", "role" : "ADMIN", "email" : "example@huawei.com", "phone" : "12345678910", "areacode" : "0086", "settings" : { "job_quota" : 10, "cpu_quota" : 50, "mem_quota" : 128, "job_timeout" : 1, "projects_per_user" : 2 }}

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs/{auto_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 auto_job_id 是 String 作业id 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 data_job_id 是 String 数据作业id 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 归档设置记录总数 configs Array of GetArchiveConfigRsp objects 配置项 表4 GetArchiveConfigRsp 参数 参数类型 描述 region_id String 华为云项目 current_region Boolean 该区域是否是当前设置的归档区域 缺省值：false

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 X-Delete-Now 否 Boolean 非核心项目删除立即删除标记 缺省值：false

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：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 作业基本信息。 file 是 ClusteringDrugFile object 分子文件。 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称，取值范围：[5,64]，允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度：5 最大长度：64 labels 否 Array of strings 标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。 最小长度：1 最大长度：32 数组长度：0 - 5 upstream_job_info 否 String 上游作业信息。 最小长度：1 最大长度：10240 表5 ClusteringDrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源：用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值： PRIVATE PUBLIC RAW url 否 String 文件URL，当数据源为用户私有数据中心为项目路径，为公共数据场景时为obs地址。 最小长度：1 最大长度：2000 format 否 String 文件格式，支持SMI，仅数据源为RAW时提供。 最小长度：1 最大长度：6 data 否 String 文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000

响应示例 状态码： 201 CREATED 创建聚类分析作业成功。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" } 创建聚类分析作业成功，当前运行作业数已达配额限制，此作业会等待。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/clustering 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID。 最小长度：1 最大长度：128

请求示例 创建聚类分析作业，输入方式为分子文件，作业名称为demo-job。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/{job_id}/clustering { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 归档描述，最大长度为1000 最小长度：0 最大长度：1000 name 是 String 归档名称,最大长度为100 最小长度：1 最大长度：100 sub_paths 是 Array of strings 归档路径集 最小长度：1 最大长度：2000 数组长度：1 - 50 storage_type 否 String 存储类型，可选择标准（STANDARD）或归档存储（COLD） 枚举值： STANDARD COLD delete_archived_data 否 Boolean 是否删除已归档数据

请求示例 归档数据，归档模式为STANDARD，归档的子路径为folder1和folder2。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups{ "name" : "归档2021", "sub_paths" : [ "folder1/", "folder2/" ], "storage_type" : "STANDARD", "delete_archived_data" : false, "description" : "归档2021"}

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 method 是 String 认证方式:sms，email，vmfa 最小长度：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" } ]}

响应示例 状态码： 201 CREATED { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "app_infos" : [ { "app_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "app_name" : "demo-app", "app_version" : "1.0.0", "app_node_labels" : [ "health.node" ] } ], "job_info" : { "job_name" : "demo-job", "job_node_labels" : [ "health.node" ] }}

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128