华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 资产id name String 资产名 title String 资产展示名 category String 类别 labels Array of strings 资产标签列表 vendor_id String 供应商id version VersionRsp object 资产版本信息 create_time String 创建时间 update_time String 更新时间 表4 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 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 X-Delete-Now 否 Boolean 非核心项目删除立即删除标记 缺省值:false
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 用户名,长度5~31之间,首位不能为数字,特殊字符只能包含下划线“_”、中划线“-”和空格 最小长度:5 最大长度:32 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 POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 job_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参数 参数 是否必选 参数类型 描述 name 否 String 策略名称 最小长度:1 最大长度:64 max_nodes 否 Integer 扩容节点数上限 最小值:0 最大值:50 min_nodes 否 Integer 扩容节点数下限 最小值:0 最大值:50 cpu_rule_enable 否 Boolean 是否启用cpu规则 cpu_percent 否 Integer cpu分配率百分比 最小值:1 最大值:100 add_nodes_for_cpu_rule 否 Integer 满足扩容策略中cpu分配率时增加的节点数 最小值:1 最大值:50 mem_rule_enable 否 Boolean 是否启用mem规则 mem_percent 否 Integer mem分配率百分比 最小值:1 最大值:100 add_nodes_for_mem_rule 否 Integer 满足扩容策略中mem分配率时增加的节点数 最小值:1 最大值:50
  • 请求示例 更新扩容策略配置,更改名称为strategy_4vCPUS_8GB https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/system/autoscaler/scale-out-policies/{id} { "name" : "strategy_4vCPUS_8GB", "max_nodes" : 50, "min_nodes" : 0, "cpu_rule_enable" : true, "cpu_percent" : 80, "add_nodes_for_cpu_rule" : 1, "mem_rule_enable" : true, "mem_percent" : 80, "add_nodes_for_mem_rule" : 1 }
  • URI GET /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
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 实例id name String 实例名称 description String 描述 template TemplateRsp object 模板详情 creator String 创建者 create_time String 创建时间 update_time String 更新时间 data_count Long 数据条目 source_project_name String 源项目名 source_project_id String 源项目id source_id String 源实例id is_prefab Boolean 是否为预置实例 表4 TemplateRsp 参数 参数类型 描述 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 是否是预置模板 表5 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
  • 响应示例 状态码: 200 OK { "name" : "demo-instance", "description" : "description", "template" : { "id" : "44e0f1b0-ac10-46a5-8fa7-b26831d7d488", "name" : "demo-template", "description" : "description", "source_project_name" : "source project", "source_project_id" : "16e0f1b0-ac10-46a5-8fa7-b26831d7d488", "source_template_id" : "36e0f1b0-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 }, "creator" : "demo-user", "create_time" : "2021-01-29T09:10:27Z", "update_time" : "2021-01-29T09:10:27Z", "data_count" : 1000, "source_project_name" : "source-project", "source_project_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "source_id" : "44e0f1b0-ac10-46a5-8fa7-b26831d7d488", "is_prefab" : false }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 policies Array of ScaleOutPolicyRsp objects 扩容策略列表 表4 ScaleOutPolicyRsp 参数 参数类型 描述 id String 策略ID name String 策略名称 status String 状态 create_time String 创建时间 node_spec NodeSpecDto object 节点规格信息 availability_zone String 可用区 nodes Integer 节点数量 max_nodes Integer 扩容节点数上限 min_nodes Integer 扩容节点数下限 scaling_times Integer 伸缩次数 scaling_enable Boolean 是否开启自动扩容 表5 NodeSpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64 ram Long 内存 vcpus String vcpus
  • 响应示例 状态码: 200 OK { "count" : 1, "policies" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "strategy_4vCPUS_8GB", "status" : "normal", "create_time" : "2021-02-01T14:25:50Z", "node_spec" : { "code" : "eihealth.xxx.spec.xxx.xxx", "name" : "xxx", "ram" : 8192, "vcpus" : 4 }, "availability_zone" : "cn-north-7c", "nodes" : 1, "max_nodes" : 10, "min_nodes" : 0, "scaling_times" : 3, "scaling_enable" : true } ] }
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/label-pages/{label_page_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 label_page_id 是 String 标签页面id 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/statistics 表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参数 参数 是否必选 参数类型 描述 file 是 ReceptorDrugFileReq object 受体文件。 remove_water 否 Boolean 去除水分子。 缺省值:false remove_ion 否 Boolean 去除离子。 缺省值:false remove_ligand 否 Boolean 去除配体分子。 缺省值:false add_hydrogen 否 Boolean 增加氢原子。 缺省值:false 表4 ReceptorDrugFileReq 参数 是否必选 参数类型 描述 source 是 String 受体的数据源:外部网络数据(如R CS B在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: 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
  • 响应示例 状态码: 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
  • 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
  • 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
  • 请求参数 表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 表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 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" } ] }
  • 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 }
  • 响应参数 状态码: 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 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参数 参数 是否必选 参数类型 描述 smiles 是 String 分子SMILES表达式。 最小长度:1 最大长度:512
  • 请求参数 表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
共100000条