华为云用户手册

  • 响应示例 状态码: 200 OK { "total_count" : 100, "unread_count" : 50, "notices" : [ { "id" : 123456, "type" : "RESOURCE", "is_read" : true, "detail" : "notice detail", "create_time" : "2022-11-24 09:33:56" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 通知消息总数 unread_count Integer 通知消息未读总数 notices Array of NoticeRsp objects 通知消息列表 表5 NoticeRsp 参数 参数类型 描述 id String 消息id type String 消息类型 detail String 消息详情 create_time String 消息创建时间 is_read Boolean 是否已读
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 code 否 String 验证码 最小长度:6 最大长度:8 method 否 String 认证方式 最小长度:1 最大长度:128 original_password 是 String 原始密码 最小长度:0 最大长度:128 new_password 是 String 新密码 最小长度:8 最大长度:32
  • 请求示例 重置新用户密码,校验码为string,校验方法为string,修改原始密码Original_Password@为New_Password@ https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/{user_id}/init-password { "code" : "string", "method" : "string", "original_password" : "Original_Password@", "new_password" : "New_Password@" }
  • 请求示例 创建模板,模板名为demo-template,有一列名为colum1,类型为Long,值不可为null,且为主键,可搜索 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates { "name" : "demo-template", "description" : "description", "columns" : [ { "name" : "column1", "type" : "Long", "description" : "description", "nullable" : false, "primary" : true, "searchable" : true, "unique" : true, "tips" : "tips" } ] }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates 表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参数 参数 是否必选 参数类型 描述 name 是 String 模板名称 最小长度:3 最大长度:32 description 否 String 模板描述 最小长度:0 最大长度:1024 columns 是 Array of DatabaseColumnDto objects 数据库列信息 数组长度:1 - 100 表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 PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/policy 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 请求示例 设置项目级权限控制策略,设置项目级数据可删除,可下载,可分享,启动加密模式。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/policy { "data_delete" : true, "data_download" : true, "data_encrypted" : true, "data_share" : true }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 data_delete 是 Boolean 项目级删除策略(true:允许项目数据删除操作,false:不允许删除操作,默认为true) 缺省值:true data_download 是 Boolean 项目级下载策略(true:允许项目数据下载操作,false:不允许下载操作,默认为true) 缺省值:true data_encrypted 是 Boolean 项目级加密策略(true:允许项目 数据加密 操作,false:不允许加密操作,默认为false) 缺省值:false data_share 是 Boolean 项目级分享策略(true:允许项目数据拷贝/引用操作,false:不允许拷贝/引用操作,默认为true) 缺省值:true
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 source 是 String 受体的数据源:外部网络数据(如R CS B在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值: EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format 否 String 文件格式,支持PDB、SDF、MOL2、SMI、CIF,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data 否 String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/smiles 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128
  • 请求示例 配体格式转换为SMILES,若配体文件中存在多个分子,则只取第一个返回。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/smiles { "source" : "RAW", "url" : "https://files.rcsb.org/download/1TQN.pdb", "format" : "PDB", "data" : "MODEL1.xxxxxxx.END" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 shareable 是 Boolean 是否共享。
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups/{backup_id}/paths 表1 路径参数 参数 是否必选 参数类型 描述 backup_id 是 String 归档ID 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks/{notebook_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 notebook_id 是 String notebook 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参数 参数 是否必选 参数类型 描述 description 是 String notebook描述信息,取值范围[0,1024] 最小长度:0 最大长度:1024
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs/{auto_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 auto_job_id 是 String 作业id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 study_id 是 String study_id 最小长度:1 最大长度:128
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/images/{image_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 image_id 是 String 镜像id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/bucket-storage 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "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, "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 }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 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 是否开启自动扩容 cpu_rule_enable Boolean 是否开启cpu执行策略 cpu_percent Integer cpu分配率百分比 add_nodes_for_cpu_rule Integer 满足扩容策略中cpu分配率时增加的节点数 mem_rule_enable Boolean 是否开启mem执行策略 mem_percent Integer mem分配率百分比 add_nodes_for_mem_rule Integer 满足扩容策略中mem分配率时增加的节点数 表4 NodeSpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64 ram Long 内存 vcpus String vcpus
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 schedulable 是 Boolean 是否可调度
  • 请求示例 创建计算资源,指定可用区、规格,购买一台 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/system/computing-resources { "availability_zone_id" : "cn-north-7c", "spec_code" : "eihealth.xxx.spec.xxx.xxx", "count" : 1 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 availability_zone_id 是 String 可用区 最小长度:1 最大长度:64 spec_code 是 String 规格编码 最小长度:1 最大长度:64 count 是 Integer 购买数量 最小值:1 最大值:10 data_disk_spec_code 否 String 额外数据盘规格编码 最小长度:1 最大长度:64 data_disk_size 否 Integer 额外数据盘大小 最小值:100 最大值:32768
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总条数 data_jobs Array of DataJobRsp objects 数据作业列表 表5 DataJobRsp 参数 参数类型 描述 creator String 数据作业创建者 end_time String 数据作业结束时间 id String 数据作业ID name String 数据作业名称 create_time String 数据作业创建时间 status String 数据作业状态 finish_count Integer 数据作业完成数 total_count Integer 数据作业总数 type String 数据作业类型 failed_reason String 数据作业失败原因 additions String 附加信息
  • 响应示例 状态码: 200 OK { "count" : 30, "data_jobs" : [ { "creator" : "creator", "end_time" : "2021-04-21T09:30:37Z", "id" : "94116a6b-1945-4581-b64c-2cea712988ab", "name" : "DataDelete-20210421093037", "create_time" : "2021-04-21T09:30:37Z", "status" : "SUCCEED", "finish_count" : 4, "total_count" : 10, "type" : "DELETE_DATA" } ] }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 creator 否 String 创建者名称 最小长度:1 最大长度:128 from_time 否 Long 查询该时间之后创建的数据作业 最小值:1000000000000 最大值:9999999999999 limit 否 Integer 查询条数 最小值:1 最大值:1000 缺省值:100 name 否 String 数据作业名称 最小长度:1 最大长度:128 offset 否 Integer 查询偏移量 最小值:0 最大值:100000000 缺省值:0 status 否 String 数据作业状态 to_time 否 Long 查询该时间之前创建的数据作业 最小值:1000000000000 最大值:9999999999999 type 否 String 数据作业类型 最小长度:1 最大长度:64 finish_from_time 否 Long 查询该时间之后完成的数据作业 最小值:1000000000000 最大值:9999999999999 finish_to_time 否 Long 查询该时间之前完成的数据作业 最小值:1000000000000 最大值:9999999999999 sort_dir 否 String 排序规则 目前默认时间降序 缺省值:desc sort_key 否 String 排序规则 目前默认时间降序,支持根据status,name,type,creator,create_time,end_time
  • 响应示例 状态码: 200 OK { "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" }
共100000条