华为云用户手册

  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/optimization/{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 { "jobs" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "labels" : [ "labelA", "labelB" ], "status" : "FINISHED", "type" : "OPTIMIZATION", "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", "expect_charge_num" : 1, "real_charge_num" : 1 } ], "count" : 1 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of DrugJobDto objects 作业列表。 count Integer 作业总数。 表5 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 作业进度信息。 表6 Progress 参数 参数类型 描述 overall Float 整体进度。 estimated_finish_time Long 预计结束时间,毫秒。
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 限制量,单次查询总量,必须由数字组成,默认为100,取值范围[1,1000]。 最小值:1 最大值:1000 缺省值:100 offset 否 Integer 偏移量,查询起始偏移,必须由数字组成,默认为0,取值范围[0,100000000]。 最小值:0 最大值:100000000 缺省值:0 sort_dir 否 String 排序规则 目前默认时间降序。 缺省值:DESC sort_key 否 String 排序规则 目前默认时间降序,支持根据create_time|finish_time|running_time|total_time排序。 job_name 否 String 作业名称。 最小长度:1 最大长度:128 labels 否 Array 标签列表。 最小长度:1 最大长度:32 数组长度:0 - 5 status_list 否 Array 作业运行状态列表, 支持WAITING|RUNNING|FINISHED|FAILED|CANCELLED。 数组长度:0 - 10 type_list 否 Array 作业类型列表, 支持DOCKING|OPTIMIZATION|SYNTHESIS|FEP|POCKET_DETECTION|ADMET|SEARCH。 数组长度:0 - 10 create_start_time 否 Long 最小创建时间。 最小值:1000000000000 最大值:9999999999999 create_end_time 否 Long 最大创建时间。 最小值:1000000000000 最大值:9999999999999 finish_start_time 否 Long 最小结束时间。 最小值:1000000000000 最大值:9999999999999 finish_end_time 否 Long 最大结束时间。 最小值:1000000000000 最大值:9999999999999 total_time_range 否 String 总运行时长, 支持ONE_DAY_MORE|ONE_DAY|ONE_HOUR|TWELVE_HOUR。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 实例个数 instances Array of TaskInstanceRsp objects 实例响应结构体 表5 TaskInstanceRsp 参数 参数类型 描述 status TaskInstanceStatusRsp object 实例状态信息 metadata TaskInstanceMetadataRsp object 实例元数据信息 spec TaskInstanceSpecRsp object 实例cpu和内存使用率信息 表6 TaskInstanceStatusRsp 参数 参数类型 描述 phase String 实例执行状态 pod_ip String 实例IP host_ip String 实例所在节点IP host_name String 计算节点的名称 start_time String 实例创建时间 container_statuses Array of TaskInstanceContainerStatusRsp objects 实例状态信息 表7 TaskInstanceContainerStatusRsp 参数 参数类型 描述 restart_count Integer 重启次数 表8 TaskInstanceMetadataRsp 参数 参数类型 描述 name String 实例名称 namespace String 命名空间 表9 TaskInstanceSpecRsp 参数 参数类型 描述 containers Array of TaskInstanceSpecContainersRsp objects 实例详情响应体 表10 TaskInstanceSpecContainersRsp 参数 参数类型 描述 resources TaskInstanceSpecConResourceRsp object task实例规格信息 表11 TaskInstanceSpecConResourceRsp 参数 参数类型 描述 limits TaskInstanceSpecConResLimitRsp object task资源限制值 requests TaskInstanceSpecConResRequestRsp object task资源需求值 表12 TaskInstanceSpecConResLimitRsp 参数 参数类型 描述 cpu String CPU限制值 memory String 内存限制值 表13 TaskInstanceSpecConResRequestRsp 参数 参数类型 描述 cpu String CPU申请值 memory String 内存申请值
  • 响应示例 状态码: 200 OK { "count" : 0, "instances" : [ { "status" : { "phase" : "Failed", "pod_ip" : "192.168.0.1", "host_ip" : "192.168.0.1", "host_name" : "health-f789d9c5-e8e6-44e7-84fb-8e234bba1cee", "start_time" : "2021-01-30T02:34:36Z", "container_statuses" : [ { "restart_count" : 0 } ] }, "metadata" : { "name" : "string", "namespace" : "default" }, "spec" : { "containers" : [ { "resources" : { "limits" : { "cpu" : "string", "memory" : "string" }, "requests" : { "cpu" : "string", "memory" : "string" } } } ] } } ] }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/instances 表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
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 dev_user_pool Boolean notebook是否使用专属资源池 has_dev Boolean 是否集成开发环境 has_drug Boolean 是否部署药物虚拟筛选 has_encryption_button Boolean 是否显示加密按钮 deploy_mode String 医疗智能体部署模式 enable_cold_archive Boolean 是否支持归档类型存储 public_bucket_path String 医疗智能体公共数据桶https路径
  • 响应示例 状态码: 200 OK { "dev_user_pool" : false, "has_dev" : false, "has_drug" : false, "has_encryption_button" : false, "deploy_mode" : "basic", "enable_cold_archive" : true, "public_bucket_path" : "https://bucket.obs.cn-north-4.myhuawei.com" }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/transfer 表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参数 参数 是否必选 参数类型 描述 user_id 是 String 转移用户id 最小长度:1 最大长度:64
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/subscribe 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 资产订阅目标项目 最小长度:1 最大长度:128 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参数 参数 是否必选 参数类型 描述 asset_id 是 String 资产ID 最小长度:1 最大长度:128 overwrite 否 Boolean 执行策略(true:全部覆盖,false:全部跳过,默认为true) 缺省值:true target_folder 否 String 目标文件夹 最小长度:1 最大长度:2000 version 是 String 版本号 最小长度:1 最大长度:128
  • 请求示例 订阅资产市场数据,资产数据版本为v1.0,使用覆盖模式,目的目录为test。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/subscribe { "asset_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "version" : "v1.0", "overwrite" : true, "target_folder" : "test/" }
  • URI DELETE /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 { "basic_info" : { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "labels" : [ "labelA", "labelB" ], "status" : "FINISHED", "type" : "POCKETDETECTION", "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 }, "params" : { "timestep_size" : 0.001, "num_minimization_steps" : 20000, "pre_equilibrium_time" : 100, "pocket_detection_time" : 50, "num_surface_points" : 30, "probe_radius" : 1.4 }, "receptor" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "ligand" : { "source" : "PRIVATE", "url" : "project:/dir/file" } }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-detection/{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 作业基本信息。 receptor ReceptorDrugFile object 受体文件。 ligand ProbeDrugFile object 探针文件。 params PocketDetectionParamDto object 靶点口袋发现设置参数。 表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 ReceptorDrugFile 参数 参数类型 描述 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 表7 ProbeDrugFile 参数 参数类型 描述 source String 受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format String 文件格式,支持PDB、SDF、MOL2,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 表8 PocketDetectionParamDto 参数 参数类型 描述 timestep_size Double 时间步长,单位ps。 最小值:0.001 最大值:0.002 缺省值:0.002 num_minimization_steps Integer 最小化步数。 最小值:5000 最大值:50000 缺省值:20000 pre_equilibrium_time Integer 预平衡时长,单位ps。 最小值:20 最大值:200 缺省值:100 pocket_detection_time Integer 口袋发现时长,单位ns。 最小值:20 最大值:50 缺省值:50 num_surface_points Integer 表面原子离散点数量。 最小值:10 最大值:50 缺省值:20 probe_radius Double 探针半径,单位A 最小值:1.4 最大值:5 缺省值:1.4
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 X-Language 是 String Locale语言信息, zh_cn返回中文,en-us返回英文 最小长度:1 最大长度:10
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-traces 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 数据对象(目录,文件)总数量 datas Array of DataSummaryRsp objects 数据对象列表 next_marker String 下一页开始标签 表5 DataSummaryRsp 参数 参数类型 描述 path String 对象全路径(项目名称:/路径) name String 名称 type String 枚举值: FILE FOLDER size Long 大小 缺省值:0 create_time String 创建时间 allowed_operate Boolean 可操作标记 缺省值:true deletable Boolean 可删除标记 缺省值:true
  • 响应示例 状态码: 200 OK { "count" : 1, "datas" : [ { "path" : "test-project-id:/db_test1.txt", "name" : "db_test1.txt", "type" : "FILE", "size" : 1024, "create_time" : "2021-02-01T14:25:34Z", "allowed_operate" : true, "deletable" : true } ], "next_marker" : "text-01" }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 限制量,单次查询总量,必须由数字组成,默认为100,取值范围[1,1000] 最小值:1 最大值:1000 缺省值:100 offset 否 Integer 偏移量,查询起始偏移,必须由数字组成,默认为0,取值范围[0,100000000] 最小值:0 最大值:100000000 缺省值:0 path 否 String 指定文件夹(项目名称:/路径) 最小长度:0 最大长度:2000 search_key 否 String 查询关键词 最小长度:0 最大长度:2000 sort_dir 否 String 降序或升序(分别对应desc和asc,默认为desc) 缺省值:desc sort_key 否 String 排序字段(支持type,create_time) marker 否 String 开始标签 最小长度:0 最大长度:2000
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 role 是 String 角色类型:管理员(ADMIN)、操作者(OPERATOR) 枚举值: ADMIN OPERATOR
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/workflows/{workflow_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 workflow_id 是 String 流程id 最小长度:1 最大长度:128
  • 基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用创建的用户进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在医疗智能体平台控制台的我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区(AZ,Availability Zone) 一个AZ是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 父主题: 使用前必读
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/buckets 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 桶个数 buckets Array of ProjectBucketRsp objects 桶列表 表4 ProjectBucketRsp 参数 参数类型 描述 eihealth_project_id String 项目编号 eihealth_project_name String 项目名称 type String 桶类型(real:项目桶,quote:引用桶) quote_root Boolean 是否引用桶根路径
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/retry 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 job_id 是 String job_id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 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
共100000条