华为云用户手册

  • 响应示例 状态码: 200 预处理成功响应。 CRYST1 48.140 48.140 135.230 90.00 90.00 90.00 P 43 2 2 1 ATOM 1 N ALA A 1 35.884 42.999 47.573 1.00 25.71 N ATOM 2 CA ALA A 1 36.605 42.605 46.370 1.00 25.42 C ATOM 3 C ALA A 1 36.452 41.114 46.099 1.00 28.64 C ATOM 4 O ALA A 1 36.341 40.696 44.945 1.00 29.91 O ATOM 5 CB ALA A 1 38.067 42.957 46.503 1.00 25.88 C ATOM 6 N PHE A 2 36.444 40.321 47.165 1.00 22.84 N ATOM 7 CA PHE A 2 36.284 38.877 47.030 1.00 24.16 C ATOM 8 C PHE A 2 34.841 38.439 46.851 1.00 31.28 C ATOM 9 O PHE A 2 34.564 37.311 46.446 1.00 33.32 O ATOM 10 CB PHE A 2 36.891 38.155 48.230 1.00 25.68 C ATOM 11 CG PHE A 2 38.356 38.400 48.371 1.00 27.21 C ... ATOM 978 CG1 VAL A 125 28.999 36.704 35.986 1.00 42.41 C ATOM 979 CG2 VAL A 125 28.985 36.848 38.447 1.00 40.25 C ATOM 980 OXT VAL A 125 30.927 33.454 36.764 1.00 62.81 O1- TER
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 file 是 ReceptorDrugFileReq object 受体文件。 remove_water 否 Boolean 去除水分子。 缺省值:false remove_ion 否 Boolean 去除离子。 缺省值:false remove_ligand 否 Boolean 去除配体分子。 缺省值:false add_hydrogen 否 Boolean 增加氢原子。 缺省值:false 表4 ReceptorDrugFileReq 参数 是否必选 参数类型 描述 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
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/receptor/preprocess 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "count" : 15, "assets" : [ { "id" : "aa78f595-5acb-4be8-b277-229be335633a", "category" : "WORKFLOW", "name" : "Docking Summary", "title" : "Docking Summary", "labels" : [ "molecular docking", "drug discovery", "smallMolecularChemicals" ], "picture" : "https://eihealth.obs.cn-north-4.huawei.com:443/assets/metadata/picture.png", "vendor_id" : "00000000000000000000000000000000", "versions" : [ { "version" : "1.0.0", "publisher" : "EIHealth", "description" : "", "summary" : "summary", "license" : "", "status" : "NORMAL", "failed_reason" : "internal error", "labels" : [ "molecular docking", "drug discovery", "smallMolecularChemicals" ], "picture" : "https://eihealth.obs.cn-north-4.huawei.com:443/assets/metadata/picture.png", "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z" } ], "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z", "stars" : 0, "subscribes" : 1 } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 资产总数 assets Array of GetAssetRsp objects 资产列表 表5 GetAssetRsp 参数 参数类型 描述 id String 资产id category String 类别 name String 资产名 title String 资产展示名 labels Array of strings 资产标签列表 picture String 资产封面图访问链接 vendor_id String 供应商id versions Array of VersionRsp objects 资产版本号列表 create_time String 创建时间 update_time String 更新时间 stars Integer 收藏数 subscribes Integer 订阅数 表6 VersionRsp 参数 参数类型 描述 version String 资产版本号 publisher String 发布者 description String 资产长描述 summary String 资产短描述 license String 许可证 status String 资产状态 failed_reason String 资产发布失败原因 labels Array of strings 资产标签列表 picture String 资产封面图访问链接 create_time String 创建时间 update_time String 更新时间
  • URI GET /v1/{project_id}/assets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 categories 否 String 资产类别,支持IMAGE/APP/WORKFLOW/DATASET,支持查询多个,以','分割 最小长度:0 最大长度:2000 key_word 否 String 关键字,支持在资产名、资产标题、短描述、长描述中搜索 最小长度:0 最大长度:2000 labels 否 String 标签,支持查询多个,以','分割 最小长度:0 最大长度:2000 limit 否 Integer 返回记录限制 最小值:1 最大值:1000 缺省值:100 offset 否 Integer 偏移量 最小值:0 最大值:100000000 缺省值:0 publishers 否 String 发布者,支持查询多个,以','分割 最小长度:0 最大长度:2000 scope 是 String 查询范围,支持PUBLIC/INTERNAL/SELF 最小长度:1 最大长度:128 vendor_ids 否 String 供应商,支持查询多个,以','分割 最小长度:0 最大长度:2000
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id}/jobs/{job_id}/3d-structure 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 study_id 是 String study_id 最小长度:1 最大长度:128 job_id 是 String study作业id 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 ligand 是 String 配体名称 最小长度:1 最大长度:200 receptor 是 String 受体名称 最小长度:1 最大长度:200
  • 响应示例 状态码: 200 OK { "vendors" : [ { "id" : "09e517572000d42f0ffbc00161366480", "domain_id" : "09e517572000d42f0ffbc00161363380", "name" : "test", "logo" : "data:image/png;base64,iVBOxxxxx" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 供应商个数 vendors Array of VendorDto objects 供应商列表 表4 VendorDto 参数 参数类型 描述 id String 供应商id 最小长度:0 最大长度:128 domain_id String 账号id 最小长度:1 最大长度:32 name String 名称 最小长度:1 最大长度:100 logo String logo图片base64编码 最小长度:0 最大长度:1500000
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 文件流对象 name 是 String 供应商名称 最小长度:1 最大长度:30
  • 响应示例 状态码: 200 OK { "count" : 0, "resources" : [ { "id" : "string", "resource_id" : "string", "spec" : { "code" : "string", "name" : "string" }, "disk" : { "type" : "string", "space" : 0, "encrypt" : true, "used" : 0 }, "charge_mode" : "string", "period_num" : 0, "create_time" : "2021-09-02T11:51:30Z", "status" : "DEPLOYING" } ] }
  • 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-Resource-Mappings String 业务id与资源id的映射关系 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of DatabaseResourceRsp objects 数据库资源列表 表5 DatabaseResourceRsp 参数 参数类型 描述 id String 实例ID resource_id String 资源ID spec DatabaseSpecDto object 数据库规格信息 disk DatabaseDiskDto object 数据库磁盘信息 charge_mode String 计费模式 period_num Integer 购买周期 create_time String 购买时间,UTC时间 failure_reason String 失败原因 status String 枚举值: DEPLOYING NORMAL UPDATINTG ABNORMAL FREEZE DELETING 表6 DatabaseSpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64 表7 DatabaseDiskDto 参数 参数类型 描述 type String 磁盘类型 space Integer 磁盘大小,单位GB encrypt Boolean 是否加密 used Double 磁盘已使用量,单位GB
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 模板id name String 模板名称 description String 模板描述 source_project_name String 来源项目名称 source_project_id String 来源项目id source_template_id String 来源模板id creator String 创建者 columns Array of DatabaseColumnDto objects 数据库列信息列表 create_time String 创建时间 primary_key String 主键 is_prefab Boolean 是否是预置模板 表4 DatabaseColumnDto 参数 参数类型 描述 name String 列名 最小长度:1 最大长度:55 type String 列类型 枚举值: Long String Double description String 列描述信息 最小长度:0 最大长度:1024 nullable Boolean 列是否允许为空 primary Boolean 是否作为主键 searchable Boolean 是否可查询 unique Boolean 是否唯一 tips String 查询参数格式的提示信息 最小长度:0 最大长度:1024
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 template_id 是 String 模板id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "name" : "demo-template", "description" : "description", "source_project_name" : "source project", "source_project_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "source_template_id" : "86e0f1b0-ac10-46a5-8fa7-b26831d7d488", "creator" : "demo-user", "columns" : [ { "name" : "column1", "type" : "Long", "description" : "description", "nullable" : false, "primary" : true, "searchable" : true, "unique" : true, "tips" : "tips" } ], "create_time" : "2021-01-29T09:10:27Z", "primary_key" : "ID,GROUP", "is_prefab" : false }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 smiles 是 String 分子SMILES表达式。 最小长度:1 最大长度:512
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/sdf 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_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 最大长度:56 version 是 String 资产版本 最小长度:1 最大长度:24 title 否 String 展示名 最小长度:0 最大长度:128 picture 否 String 封面图片base64编码 最小长度:0 最大长度:50000 summary 否 String 短描述 最小长度:0 最大长度:128 description 否 String 长描述 最小长度:0 最大长度:65535 labels 否 Array of strings 标签列表 最小长度:1 最大长度:32 数组长度:0 - 5
  • 请求示例 发布应用资产,资产名称为demo-app,版本为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/publish { "name" : "demo-app", "version" : "1.0.0", "picture" : "", "labels" : [ "label1", "label2" ], "summary" : "summary", "description" : "description" }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/{app_id}/publish 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 app_id 是 String 应用id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "basic_info" : { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "labels" : [ "labelA", "labelB" ], "status" : "FINISHED", "type" : "POCKE_MOL_DESIGN", "start_time" : "2021-01-30T02:34:36Z", "create_time" : "2021-01-30T02:34:36Z", "finish_time" : "2021-01-30T02:53:26Z", "failed_message" : "null", "user_name" : "demo-user-name", "output_dir" : "job-analysis/job-name", "expect_charge_num" : 1, "real_charge_num" : 1 }, "receptor" : { "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" } }, "ligands" : [ { "source" : "PRIVATE" }, { "url" : "project:/dir/file" } ], "cluster_result" : { "method" : "hiq_mc", "output_dir" : "project://bucket/path/to/task/dir/", "status" : "finished", "failed_reasons" : [ { "reason" : "failed reason" }, { "count" : 1 } ] } }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-mol-design/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 job_id 是 String 作业id。 最小长度:1 最大长度:128
  • 响应示例 状态码: 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集群连接 CSS集群解绑 绑定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
共100000条