华为云用户手册

响应示例 状态码： 200 OK { "count" : 2, "projects" : [ { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fd1", "name" : "demo-project-1", "creator" : "demo-user", "role" : "Admin", "size" : 1123243536, "status" : "ACTIVE", "tags" : [ "tag1" ], "description" : "This is demo project 1", "create_time" : "2020-09-10T10:07:17Z", "update_time" : "2020-09-10T10:07:17Z" }, { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fd2", "name" : "demo-project-2", "creator" : "demo-user", "role" : "Admin", "size" : 1123243536, "status" : "TO_BE_DELETED", "tags" : [ "tag1" ], "description" : "This is demo project 2", "create_time" : "2020-09-10T10:07:17Z", "update_time" : "2020-09-10T10:07:17Z", "delete_time" : "2020-09-10T10:07:17Z" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 个数 projects Array of ProjectRsp objects 项目详情列表 表4 ProjectRsp 参数 参数类型 描述 id String 项目id name String 项目名称 creator String 项目所有者 role String 当前用户在该项目上的角色 size Long 项目桶存储量 status String 项目状态 tags Array of strings 标签列表 description String 项目描述 create_time String 项目创建时间 update_time String 项目更新时间 delete_time String 请求删除时间 is_core Boolean 核心项目标记

URI POST /v1/{project_id}/system/computing-resources/{id}/reboot 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 id 是 String 计算资源id 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否强制重启，默认为false 缺省值：false

URI GET /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

响应示例 状态码： 200 OK { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "description" : "description", "labels" : [ "labelA", "labelB" ], "status" : "COMPLETED", "has_ignore_failed_tasks" : false, "create_time" : "2021-01-30T02:53:26Z", "finish_time" : "2021-01-30T02:53:26Z", "workflow_name" : "demo-workflow", "workflow_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "command_line" : "nextflow run main.nf", "params" : [ { "name" : "p1", "value" : "hello", "type" : "Other", "description" : "desc", "required" : true } ], "config_files" : [ "nextflow.config" ], "config_context" : "config content" }

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

修订记录 文档版本 发布日期 修改说明 13 2024-05-09 新增 测试 CSS 集群连接 CS S集群解绑 绑定CSS集群 获取CSS集群列表 获取最终租户CSS集群列表 创建分子或分子复合物批量下载任务详情 查询分子或分子复合物批量下载任务详情 创建数据库 删除数据库 更新药物数据库 数据库追加文件 获取数据库列表 查询分子搜索作业详情 更新药物作业 创建分子搜索作业 修改 下载文件 获取跨域归档配置 生成分子SVG图 获取分子优化作业详情 创建分子优化作业 12 2023-09-20 新增 创建靶点口袋发现作业 查询靶点口袋发现作业详情 创建分子属性预测作业 查询分子属性预测作业详情 创建靶点口袋分子设计作业 查询靶点口袋分子设计作业详情 创建模型 获取模型列表 更新药物模型 删除模型 获取策略伸缩历史 获取策略事件 获取策略关联计算资源列表 修改 查询分子优化作业详情 创建分子优化作业 查询自由能微扰作业详情 查询分子对接作业详情 获取Nextflow作业详情 创建nextflow作业 11 2023-07-26 新增 API（盘古辅助制药平台） 10 2023-04-27 新增 计算资源扩缩容 查询 IAM 用户列表 查询IAM用户组列表 查询IAM用户组的用户列表 Nextflow接口 ADMET属性预测接口(默认+自定义属性) 分子合成路径规划任务（MSP） 自定义属性任务（MCP） 修改 错误码（ 医疗智能体 与盘古辅助制药平台） 09 2023-03-24 下线医学影像和临床研究相关接口。 08 2023-01-30 消息中心管理新增 获取通知消息列表 批量删除通知消息 批量更新消息 用户管理新增 导入用户 流程管理 统计全局流程、作业信息 作业管理新增 获取子任务中实例的资源监控数据 更新 性能加速管理 计算资源管理 作业配置设置和获取 消息中心管理 医疗平台信息获取 流程管理 作业管理 AI辅助医疗药物设计接口 分子设计支持上传受体进行对接打分优化 分子设计支持多个子结构强约束 分子搜索支持ZINC数据库 07 2022-10-30 标签管理新增 批量删除标签 镜像管理新增 发布镜像 应用管理新增 发布应用 流程管理新增 发布流程 资产管理新增 更新资产指定版本的信息 操作资产发布状态 删除资产指定版本 宫颈癌细胞病理筛查接口优化 分子生成支持初始小分子库 06 2022-09-29 分子设计支持上传受体进行对接打分优化 分子设计支持多个子结构强约束 分子搜索支持ZINC数据库 05 2022-07-30 系统管理新增1个API： 查询bms计算资源显卡id列表 数据管理新增3个API： 插入单条数据 删除数据 更新数据 作业管理新增10个API： 获取子任务实例信息 获取子任务中实例的事件 获取子任务中实例的pod信息 获取自动作业模板列表 创建自动作业模板 删除自动作业模板 更新自动作业模板 查询自动作业模板 启动自动作业 停止自动作业 04 2022-04-08 上线临床研究和药物设计API： 诊断建议 鉴别诊断建议 检查检验建议 治疗建议 分子生成 分子优化 靶点化合物结合预测 分子属性预测 03 2021-12-30 新增系统管理、数据库管理、资产市场、Notebook开发环境等接口。 02 2021-08-23 新增镜像管理接口。 01 2021-03-08 第一次正式发布。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限， 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 source 是 String 受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值： EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：1 最大长度：2000 format 否 String 文件格式，仅支持PDB，仅数据源为RAW时提供。 最小长度：1 最大长度：6 data 否 String 文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000 add_hydrogen 否 Boolean 增加氢原子。 缺省值：true

请求示例 受体信息解析，如果有多个受体蛋白则只处理第一个，如果一个受体蛋白里结合了多个配体，则最多只处理前10个。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/receptor/info { "source" : "RAW", "url" : "https://files.rcsb.org/download/1TQN.pdb", "format" : "PDB", "data" : "MODEL1.xxxxxxx.END" }

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

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

请求示例 创建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。 最小长度：1 最大长度：32768 表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 数组长度：0 - 5 main_file 是 String 主文件名 最小长度：4 最大长度：1023 params 否 File 流程参数列表文件，取值范围[0, 10M]

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

响应示例 状态码： 200 OK { "path" : "2022|02|21|eiHealth-project_CloudTrace_cn-north-7_2022-02-21T02-31-09Z_a45fc9849d217b43.json.gz", "name" : "eiHealth-project_CloudTrace_cn-north-7_2022-02-21T02-31-09Z_a45fc9849d217b43.json.gz", "type" : "FILE", "size" : 438, "create_time" : "2022-02-21T02:31:09Z", "download_url" : "https://aos-eihealth-for-trace-***/***60.json.gz" }

响应示例 状态码： 200 OK { "count" : 1, "flavors" : [ { "code" : "eihealth.dbm.spec.basic", "name" : "string", "cpu" : 0, "ram" : 0, "max_connections" : 0, "disk_space" : 0, "sold_out" : true } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 个数 flavors Array of DatabaseFlavorRsp objects 规格列表 表4 DatabaseFlavorRsp 参数 参数类型 描述 code String 规格编号 name String 规格名称 cpu Integer 核数 ram Integer 内存 max_connections Integer 最大连接数 disk_space Integer 存储空间 sold_out Boolean 是否售罄

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of QuoteDatabaseResultRsp objects OK 表6 QuoteDatabaseResultRsp 参数 参数类型 描述 source_project_id String 源项目id source_database_id String 源数据库id destination_database_id String 引用到项目后的数据库id destination_database_name String 引用到项目后的数据库名称 failed_reason String 失败原因 status String 导入结果 状态码： 207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of QuoteDatabaseResultRsp objects MULTI_STATUS 表8 QuoteDatabaseResultRsp 参数 参数类型 描述 source_project_id String 源项目id source_database_id String 源数据库id destination_database_id String 引用到项目后的数据库id destination_database_name String 引用到项目后的数据库名称 failed_reason String 失败原因 status String 导入结果

响应示例 状态码： 200 OK [ { "source_project_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "source_database_id" : "77e0f1b0-ac10-46a5-8fa7-b26831d7d488", "destination_database_id" : "25e0f1b0-ac10-46a5-8fa7-b26831d7d488", "destination_database_name" : "database_name", "failed_reason" : null, "status" : "success" } ] 状态码： 207 MULTI_STATUS [ { "source_project_id" : "55e0f1b0-ac10-46a5-8fa7-b26831d7d488", "source_database_id" : "36e0f1b0-ac10-46a5-8fa7-b26831d7d488", "destination_database_id" : "26e0f1b0-ac10-46a5-8fa7-b26831d7d488", "destination_database_name" : "database_name", "failed_reason" : "failed reason", "status" : "fail" } ]

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

请求示例 引用数据库实例，源项目ID为3b8771e4-b3c7-41d5-b29e-36906eef6778，源数据库实例ID为4b8771e4-b3c7-41d5-b29e-36906eef6776 { "source_project_id" : "3b8771e4-b3c7-41d5-b29e-36906eef6778", "source_databases" : [ { "source_database_id" : "4b8771e4-b3c7-41d5-b29e-36906eef6776" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 source_project_id 是 String 源项目id 最小长度：1 最大长度：128 source_databases 是 Array of DatabaseSrcReq objects 源数据库列表 数组长度：1 - 10 表4 DatabaseSrcReq 参数 是否必选 参数类型 描述 source_database_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参数 参数 是否必选 参数类型 描述 labels 是 Array of UpdateNodeLabelReq objects 标签列表 数组长度：0 - 100 表4 UpdateNodeLabelReq 参数 是否必选 参数类型 描述 name 是 String 标签名称 最小长度：1 最大长度：63

响应参数 状态码： 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 任务启动事件末次上报时间

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

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

响应参数 状态码： 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}/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