华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 作业基本信息。 receptor 是 ReceptorDrugFile object 受体文件。 ligand 是 ProbeDrugFile object 探针文件。 params 否 PocketDetectionParamDto object 靶点口袋发现设置参数。 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称,取值范围:[5,64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度:5 最大长度:64 labels 否 Array of strings 标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。 最小长度:1 最大长度:32 数组长度:0 - 5 表5 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 表6 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 表7 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
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-detection 表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}/project-tracker 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of ComputingResourceRsp objects 计算资源列表 表4 ComputingResourceRsp 参数 参数类型 描述 id String 实例ID resource_id String 资源ID evs_resource_id String 额外盘资源ID name String 实例名称 spec ComputingSpecDto object 规格信息 system_disk DiskDto object 系统盘 data_disks Array of DiskDto objects 数据盘 image ImageDto object 系统镜像 charge_mode String 计费模式 create_time String 购买时间 failure_reason String 失败原因 status String 状态 availability_zone_id String 可用区 schedulable Boolean 资源是否可调度 node_labels Array of strings 计算节点标签列表 表5 ComputingSpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64 ram Long 内存 vcpus String vcpus max_rate String 最大带宽 min_rate String 基准带宽 max_pps String 最大收发包能力 表6 DiskDto 参数 参数类型 描述 type String 磁盘类型 space String 磁盘大小 表7 ImageDto 参数 参数类型 描述 type String 镜像类型 version String 镜像版本
  • 响应示例 状态码: 200 OK { "count" : 1, "resources" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "spec" : { "code" : "eihealth.xxx.spec.xxx.xxx", "name" : "xxx", "ram" : 8192, "vcpus" : "a", "max_rate" : 8000, "min_rate" : 2400, "max_pps" : 800000 }, "system_disk" : { "type" : "SAS", "space" : 40 }, "data_disks" : [ { "type" : "SAS", "space" : 100 } ], "image" : { "type" : "CentOS", "version" : 1.0 }, "charge_mode" : 2, "create_time" : "2021-02-01T14:25:50Z", "status" : "ACTIVE", "availability_zone_id" : "cn-north-7c", "schedulable" : true, "node_labels" : [ "label" ] } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of PerformanceResourceRsp objects 性能加速资源列表 表4 PerformanceResourceRsp 参数 参数类型 描述 id String 实例ID resource_id String 资源ID name String 实例名称 spec SpecDto object 规格信息 availability_zone_id String 可用区 space Integer 最大容量, 单位GB free_space Double 可用容量,单位GB charge_mode String 计费模式 period_num Integer 购买周期 running_job_count Integer 作业运行数 job_quota Integer 运行的最大作业数量 create_time String 购买时间 failure_reason String 失败原因 status String 状态 schedulable Boolean 资源是否可调度 表5 SpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64
  • 响应示例 状态码: 200 OK { "count" : 1, "resources" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "instance", "spec" : { "code" : "code", "name" : "name" }, "availability_zone_id" : "cn-north-7c", "space" : 65, "free_space" : 30, "charge_mode" : 1, "period_num" : 1, "job_quota" : 8, "create_time" : "2021-02-01T14:25:50Z", "status" : "Deploying" } ] }
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups/{backup_id} 表1 路径参数 参数 是否必选 参数类型 描述 backup_id 是 String 归档ID 最小长度:1 最大长度:128 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 标签名称 最小长度:1 最大长度:32 description 否 String 标签描述 最小长度:0 最大长度:1024
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/import-from-network 表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参数 参数 是否必选 参数类型 描述 target_folder 否 String 所在文件夹 最小长度:0 最大长度:2000 urls 是 Array of strings 导入网上数据的url集 最小长度:0 最大长度:4096 数组长度:1 - 10 md5s 否 Array of strings 导入网上数据的md5集 最小长度:0 最大长度:4096 数组长度:1 - 10
  • 请求示例 导入网上数据,数据链接为https://www.hhh.com/test.txt,目的目录为test。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/import-from-network { "target_folder" : "test/", "urls" : [ "https://www.hhh.com/test.txt" ] }
  • 请求示例 修改子用户信息,修改子用户密码为example,电话为12345678910,邮箱为example@huawei.com https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/{user_id}/domain-change-info { "password" : "example", "mobile" : "12345678910", "areacode" : "0086", "email" : "example@huawei.com" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 password 否 String 新密码,在8-32位之间支持用户自定义密码长度,至少包含以下四种字符中的两种: 大写字母、小写字母、数字和特殊字符。 最小长度:8 最大长度:32 mobile 否 String 用户手机号,纯数字,长度小于等于32位,当且仅当重置手机号时传入空串。必须与国家码同时存在。 最小长度:0 最大长度:32 areacode 否 String 国家码,当且仅当重置手机号时传入空串。中国大陆为“0086” 最小长度:0 最大长度:10 email 否 String 用户邮箱,需符合邮箱格式 最小长度:0 最大长度:128
  • 请求示例 批量更新消息状态为已读 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/notices/batch-update { "notice_ids" : [ "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2" ], "operation" : "read" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 notice_ids 是 Array of strings 批量更新通知消息id列表 最小长度:1 最大长度:128 数组长度:1 - 50 operation 是 String 通知消息操作 枚举值: read
  • 响应示例 状态码: 200 OK { "expires_time" : "2022-09-02T10:08:57.686Z", "project" : { "id" : "06f1c15e6f0010672f86c00300...", "name" : "project-example-01" }, "roles" : [ { "id" : "19bb93eec4ca4f08aefdc02da76d8f3c", "name" : "readonly" } ], "user" : { "domain" : { "id" : "d78cbac186b744899480f25bd022f...", "name" : "IAMDomain" }, "id" : "086ba757f90089cf0fe5c000dbe7f...", "name" : "user-example" } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 expires_time String 过期时间 project ProjectDto object 项目 roles Array of RoleDto objects 角色 user UserDto object 用户 表4 ProjectDto 参数 参数类型 描述 id String 项目id name String 项目名 表5 RoleDto 参数 参数类型 描述 id String 角色id name String 角色名 表6 UserDto 参数 参数类型 描述 domain DomainDto object 账号 id String 用户id name String 用户名 表7 DomainDto 参数 参数类型 描述 id String 账号id name String 账号名
  • 请求示例 创建分子聚类作业。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/{job_id}/cluster { "method" : "hiq_mc", "file" : "project://bucket/path/to/task/dir/result.json", "output_dir" : "projectName://bucket/path/to/task/dir/" }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/{job_id}/cluster 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 job_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参数 参数 是否必选 参数类型 描述 method 是 String 聚类方法,当前仅支持hiq_mc。 最小长度:1 最大长度:20 file 是 String 分子聚类源数据。 最小长度:1 最大长度:2000 output_dir 是 String 分子聚类输出结果。 最小长度:1 最大长度:1200
  • 响应示例 状态码: 200 OK { "count" : 1, "histories" : [ { "rule" : "cpurule", "action" : "increase 1 node", "count_before_scale" : 2, "count_after_scale" : 3, "state" : "Successful", "time" : "2022-10-15T09:53:50Z" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 伸缩历史总数 histories Array of ScalingHistory objects 伸缩历史列表 表4 ScalingHistory 参数 参数类型 描述 rule String 策略规则 action String 执行动作 count_before_scale Integer 伸缩前节点数 count_after_scale Integer 伸缩后节点数 state String 执行状态 time String 执行时间
  • 请求示例 设置用户邮件配置,设置接受范围为全部,资源类型为system消息,语言设置为中文 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/messages/email-client-config { "scope" : "all", "resource_types" : [ "system" ], "language" : "zh_cn" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 scope 是 String 接收范围(不接收消息(none)、仅接收自己操作的消息(mine)、接收全部消息(all)) 最小长度:1 最大长度:128 resource_types 否 Array of strings 资源类型 最小长度:1 最大长度:128 数组长度:0 - 10 language 否 String 语言,只支持en_us和zh_cn 枚举值: en_us zh_cn
  • URI GET /v1/{project_id}/notices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 is_read 否 Boolean 消息状态是否已读,true返回已读,false返回未读,不填返回全部 limit 否 Integer 查询条数 最小值:1 最大值:1000 缺省值:100 offset 否 Integer 查询偏移量 最小值:0 最大值:100000000 缺省值:0
  • 响应示例 状态码: 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@" }
共100000条