华为云用户手册

响应示例 状态码： 200 OK { "count" : 0, "events" : [ { "type" : "Normal", "count" : 1, "reason" : "Started", "message" : "Started container task-2-zqy-test-0218-0-19df0004a000206", "first_timestamp" : "2021-01-30T02:34:36Z", "last_timestamp" : "2021-01-30T02:34:36Z" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 事件条数 events Array of EventRsp objects 事件列表 表5 EventRsp 参数 参数类型 描述 type String 任务启动事件类型 count Integer 任务启动事件发生次数 reason String 任务启动事件状态 message String 任务启动事件详细信息 first_timestamp String 任务启动事件首次上报时间 last_timestamp String 任务启动事件末次上报时间

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/events 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 job_id 是 String 作业id 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 task_name 是 String 子任务名称 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 task_index 否 String 子任务的并发序号 缺省值：0 最小长度：1 最大长度：128

请求示例 邮箱连通性测试， 输入服务器ip、用户名、密码、邮箱地址、语言 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/messages/email-connection-test { "server" : "192.168.0.0", "user_name" : "userName", "password" : "Password", "email" : "example@huawei.com", "language" : "en_us" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限， 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 server 是 String 服务器地址 最小长度：1 最大长度：128 user_name 是 String 用户名 最小长度：1 最大长度：128 password 是 String 密码 最小长度：1 最大长度：128 email 是 String 邮箱 最小长度：1 最大长度：128 language 是 String 语言,只支持en_us和zh_cn 枚举值： en_us zh_cn

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/instances/{instance_name}/events 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 job_id 是 String 作业id 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 task_name 是 String 子任务名称 最小长度：1 最大长度：128 instance_name 是 String 子任务实例名称 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 task_index 否 String 子任务的并发序号 缺省值：0 最小长度：1 最大长度：128

响应示例 状态码： 200 OK { "count" : 0, "events" : [ { "type" : "Normal", "count" : 1, "reason" : "Started", "message" : "Started container task-2-zqy-test-0218-0-19df0004a000206", "first_timestamp" : "2021-01-30T02:34:36Z", "last_timestamp" : "2021-01-30T02:34:36Z" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 事件条数 events Array of EventRsp objects 事件列表 表5 EventRsp 参数 参数类型 描述 type String 任务启动事件类型 count Integer 任务启动事件发生次数 reason String 任务启动事件状态 message String 任务启动事件详细信息 first_timestamp String 任务启动事件首次上报时间 last_timestamp String 任务启动事件末次上报时间

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

响应示例 状态码： 200 OK { "count" : 1, "notebooks" : [ { "id" : "DE-7d558ef8-c73d-11ea-964c-0255ac100033", "name" : "notebook-example", "description" : "notebook description in here", "creator" : "notebook_creator", "url" : "https://0.0.0.0:0000/0951eb641.../notebook/e4a3b97a.../services/notebook", "flavor" : { "cpu" : "1", "gpu" : "0", "memory" : "100" }, "status" : "Running", "image" : { "image_type" : "SYSTEM", "image_info" : { "source_project_name" : "eihealth-project", "image_name" : "eihealth-notebook", "image_tag" : "3.1.0-latest", "profile" : "PY3" } }, "storages" : [ { "path" : "project_name:/example", "mount_path" : "/example" } ], "create_time" : "2020-09-10T10:07:17Z", "update_time" : "2020-09-10T10:07:17Z", "failed_message" : "failed massage in here" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer notebook总数 notebooks Array of NotebookEntity objects notebook详情列表 表5 NotebookEntity 参数 参数类型 描述 id String notebook ID name String notebook名称 description String notebook描述 creator String notebook所属用户 url String notebook访问URL flavor FlavorInfo object notebook规格 status String notebook状态 枚举值： Running Abnormal Hibernate Succeeded Creating Deleting Updating CreatedFailed DeletedFailed UpdatedFailed Unknown image NotebookImage object notebook镜像信息 storages Array of NotebookStorage objects notebook存储信息 create_time String notebook创建时间 update_time String notebook更新时间 failed_message String notebook失败信息 events Array of TaskEventRsp objects cce事件 表6 FlavorInfo 参数 参数类型 描述 cpu Float notebook占用的cpu,0.1核为100m,单位为"C" 最小值：1 最大值：128 缺省值：1 gpu Float notebook占用的gpu，0.1为使用单卡10%，1为占满单个显卡，1+为使用多个显卡 最小值：0 最大值：16 缺省值：0 memory Float notebook占用的内存,单位为"G" 最小值：2 最大值：512 缺省值：2 表7 NotebookImage 参数 参数类型 描述 image_type String 镜像类型 枚举值： SYSTEM CUSTOMER image_info ImageInfo object 镜像信息 表8 ImageInfo 参数 参数类型 描述 source_project_name String 源项目名 最小长度：1 最大长度：128 image_name String 镜像名 最小长度：1 最大长度：128 image_tag String 镜像tag名 最小长度：1 最大长度：64 profile String 系统镜像名 枚举值： PY3 表9 NotebookStorage 参数 参数类型 描述 path String notebook存储路径 最小长度：1 最大长度：4096 mount_path String 挂载路径，由于目前暂不支持自定义挂载，暂不开放 最小长度：1 最大长度：4096 表10 TaskEventRsp 参数 参数类型 描述 type String 任务启动事件类型 count Integer 任务启动事件发生次数 reason String 任务启动事件状态 message String 任务启动事件详细信息 first_timestamp String 任务启动事件首次上报时间 last_timestamp String 任务启动事件末次上报时间

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 读取条数 最小值：1 最大值：1000 缺省值：100 name 否 String notebook名称 最小长度：1 最大长度：200 offset 否 Integer 读取偏移量 最小值：0 最大值：100000000 缺省值：0 status 否 String notebook状态

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/preview/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID。 最小长度：1 最大长度：128 task_id 是 String 任务ID，通过创建任务接口取得。 最小长度：1 最大长度：128

响应示例 状态码： 200 OK { "count" : 1, "labels" : [ { "id" : "id", "name" : "label1", "description" : "测试标签", "creator" : "user1", "create_time" : "2021-02-01T14:25:34Z", "update_time" : "2021-02-01T14:25:34Z" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Long 标签列表个数 labels Array of LabelRsp objects 标签详情 表4 LabelRsp 参数 参数类型 描述 id String 标签id name String 标签名称 description String 标签描述 creator String 标签创建者 create_time String 标签创建时间 update_time String 标签更新时间

请求示例 更新用户设置，设置开启资源配额限制，设置作业配额为10，作业超时时长为1天，CPU的核数配额为50，内存的配额为128GB，用户可创建的项目数为2 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/{user_id}/settings { "operation" : "OPEN", "settings" : { "job_quota" : 10, "job_timeout" : 1, "cpu_quota" : 50, "mem_quota" : 128 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 operation 是 String 是否开启资源配额限制 枚举值： OPEN CLOSE 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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 original_password 是 String 原始密码 最小长度：0 最大长度：128 new_password 是 String 新密码 最小长度：8 最大长度：32 ticket 否 String 预验证凭证 最小长度：0 最大长度：1024

请求示例 修改用户密码，修改密码Original_Password@为New_Password@ https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/{user_id}/password { "original_password" : "Original_Password@", "new_password" : "New_Password@", "ticket" : "ticket" }

响应示例 状态码： 200 OK { "id" : "1", "command" : "printf 'Hello World!' | split -b 6 - chunk_\n echo 'Hello World!'", "status" : "COMPLETED", "exit" : 0, "work_dir" : "/nextflow/__nextflow_work__/a49cd176-c35a-4e27-b287-659a7de1b9d9/c75e9b6b-c719-40cc-a77a -772a367b3068/bf/96d1bcb452ae0b420c74965b3b770d", "module" : [ ], "container" : "100.79.1.215:20202/hwofficial/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.215:20202/hwofficial/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 NextflowTaskExecutionTime object task执行时间信息 resource_requested NextflowTaskResourceRequested object task资源信息 resource_usage NextflowTaskResourceUsage 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，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 job_id 是 String 作业id 最小长度：1 最大长度：128 task_id 是 String task id 最小长度：1 最大长度：128

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id}/cancel 表1 路径参数 参数 是否必选 参数类型 描述 data_job_id 是 String 数据作业id 最小长度：1 最大长度：128 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参数 参数 是否必选 参数类型 描述 message_retain_number 否 Integer 最多保留记录数 最小值：10000 最大值：10000000

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

请求示例 订阅镜像，选取指定资产和版本订阅 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/images/subscribe { "asset_id" : "08f4ae64-6ade-47be-bb6a-a6d34365cfb5", "version" : "v1.0" }

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

响应示例 状态码： 200 OK { "basic_info" : { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "labels" : [ "labelA", "labelB" ], "status" : "FINISHED", "type" : "SEARCH", "create_time" : "2021-01-30T02:34:36Z", "start_time" : "2021-01-30T02:34:37Z", "finish_time" : "2021-01-30T02:53:26Z", "failed_message" : "null", "user_name" : "demo-user-name", "output_dir" : "job-analysis/job-name" }, "smiles" : "string", "top_n" : 100, "databases" : [ "databaseA", "databaseB" ], "custom_databases" : [ "custom_databaseA_id", "custom_databaseB_id" ], "search_method" : [ "ECFP_4" ] }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 basic_info DrugJobDto object 作业基本信息。 smiles String 分子SMILES表达式。 最小长度：1 最大长度：1024 scaffold String 分子骨架表达式。 最小长度：1 最大长度：1024 top_n Integer 生成分子数量。 最小值：0 最大值：1000 databases Array of strings 可供搜索分子的公共数据库名称列表。 最小长度：1 最大长度：128 数组长度：0 - 10 custom_databases Array of strings 可供搜索分子的自定义数据库名称列表。 最小长度：1 最大长度：128 数组长度：0 - 10 models Array of BasicDrugModel objects 模型信息。 search_method String 分子搜索方法。 枚举值： ECFP_4 SCAFFOLD part_failed_reason Array of FailedReasonRecord objects 部分失败原因和数量。 表4 DrugJobDto 参数 参数类型 描述 id String 作业id。 name String 作业的名称，取值范围：[1,63]，允许大小写字母、数字、以及特殊字符中划线(-)。 labels Array of strings 作业标签。 status String 作业状态。 type String 作业类型。 create_time String 作业创建时间。 finish_time String 作业结束时间。 start_time String 作业开始时间。 failed_message String 失败提示，当作业执行失败时会返回。 user_name String 创建任务的用户名称。 output_dir String 作业结果输出目录。 expect_charge_num Double 预估功能调用消耗次数。 real_charge_num Double 实际功能调用消耗次数。 progress Progress object 作业进度信息。 表5 Progress 参数 参数类型 描述 overall Float 整体进度。 estimated_finish_time Long 预计结束时间，毫秒。 表6 BasicDrugModel 参数 参数类型 描述 id String 模型ID。 task_id String 任务ID。 name String 模型名称。 creator String 模型创建者。 type String 模型类型。 value_range ValueRange object 区间上下限，仅回归型存在。 description String 模型描述信息。 表7 ValueRange 参数 参数类型 描述 lower Float 区间下限，仅回归型存在。 upper Float 区间上限，仅回归型存在。 表8 FailedReasonRecord 参数 参数类型 描述 reason String 失败原因。 count Integer 失败数量。