华为云用户手册

响应示例 状态码： 200 OK { "count" : 1, "backups" : [ { "id" : "0e228eb7-df7f-49fb-844e-84bb8df9a71a", "name" : "归档2021", "type" : "manul", "storage_type" : "STANDARD", "region" : "same", "paths" : [ "project-name:/folder1/", "project-name:/file1" ], "start_time" : "2021-02-01T14:25:34Z", "end_time" : "2021-02-01T14:25:50Z", "size" : 1024, "description" : "归档描述", "operator_name" : "测试人员01" } ] }

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups 表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 sort_dir 否 String 降序或升序（分别对应desc和asc，默认为desc） 缺省值：desc sort_key 否 String 排序字段（支持type, end_time）

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 归档记录总数量 backups Array of BackupDto objects 归档记录列表 表5 BackupDto 参数 参数类型 描述 id String id name String 归档名称 type String 类型 storage_type String 存储类型 region String 区域 paths Array of strings 归档数据路径集 start_time String 归档开始时间 end_time String 归档结束时间 archive_days Integer 已归档天数 size Long 大小 description String 归档描述 operator_name String 归档人员姓名

Token认证 Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 username为 IAM 用户名，domainname为账号名，********为用户登录密码，project name为项目名称。可登录控制台“我的凭证”页面获取。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type:application/json { "auth": { "identity": { "methods": ["password"], "password": { "user": { "name": "username", "password": "**********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" //替换为实际的project name，如cn-north-4 } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 auto_jobs Array of AutoJobListDto objects 自动作业列表 count Integer 作业总数 表5 AutoJobListDto 参数 参数类型 描述 id String 自动作业id name String 自动作业的名称，取值范围：[1,63]，允许大小写字母、数字、以及特殊字符中划线(-) description String 自动作业的描述, 取值范围：输入字符最大长度为255 labels Array of strings 自动作业标签 priority Integer 自动作业优先级，[0,9]，0表示最低，默认0 timeout Integer 作业执行超时时长，取值范围: [1, 144000]，单位：分钟，默认数值1440 最小值：1 最大值：144000 status String 自动作业状态 create_time String 自动作业创建时间 finish_time String 自动作业结束时间 failed_reason String 失败原因，当自动作业执行失败时会返回，比如依赖的数据表，流程不存在等等 user_name String 自动作业的创建者 tool_info ToolInfoDto object 作业依赖的组件信息 database_id String 自动作业依赖的数据表ID database_name String 自动作业依赖的数据表名称 表6 ToolInfoDto 参数 参数类型 描述 tool_id String 作业依赖的组件id tool_name String 作业依赖的组件名称 tool_version String 作业依赖的组件版本 tool_type String 作业依赖的组件类型，取值范围app|workflow

响应示例 状态码： 200 OK { "auto_jobs" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "description" : "description", "labels" : [ "labelA", "labelB" ], "priority" : 0, "timeout" : 1440, "status" : "SUCCEEDED", "create_time" : "2021-01-30T02:53:26Z", "finish_time" : "2021-01-30T02:53:26Z", "failed_reason" : "Database does not exist.", "user_name" : "gwj-test-01", "tool_info" : { "tool_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "tool_name" : "demo-workflow", "tool_version" : "1.0.0", "tool_type" : "workflow" }, "database_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "database_name" : "demo-database" } ], "count" : 1 }

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs 表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 sort_key 否 String 排序字段 sort_dir 否 String 排序方向，升序或降序，即ASC 和DESC 缺省值：DESC

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Language 否 String Locale语言类型，zh_cn返回中文，en_us返回英文 缺省值：en_us 最小长度：1 最大长度：10 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id}/retry 表1 路径参数 参数 是否必选 参数类型 描述 data_job_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}/datas/{path}/policy 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 path 是 String 对象全路径（项目名称:|路径） 最小长度：1 最大长度：2000 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参数 参数 是否必选 参数类型 描述 delete_policy 是 String 允许/禁止 枚举值： allow deny

响应示例 状态码： 200 受体口袋检测成功响应。 { "mode" : "AUTO", "pockets" : [ { "center" : [ 39.067, 26.472, 51.635 ], "size" : [ 6.668, 8.465, 6.582 ] }, { "center" : [ 29.013, 37.992, 54.6 ], "size" : [ 3.468, 2.754, 5.233 ] }, { "center" : [ 34.946, 18.73, 45.517 ], "size" : [ 5.178, 6.133, 5.156 ] }, { "center" : [ 32.901, 33.444, 61.459 ], "size" : [ 3.664, 4.93, 3.59 ] }, { "center" : [ 53.883, 17.701, 48.675 ], "size" : [ 3.281, 2, 10.053 ] }, { "center" : [ 47.861, 17.39, 37.703 ], "size" : [ 5.231, 2, 3.53 ] } ] }

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/receptor/pocket 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID。 最小长度：1 最大长度：128

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 mode String 口袋识别的模式：自动、全局、配体、残基。 枚举值： AUTO GLOBAL LIGAND RESIDUES pockets Array of DrugBoundingBoxDto objects 口袋列表。 数组长度：1 - 10 表7 DrugBoundingBoxDto 参数 参数类型 描述 center Array of floats 口袋中心坐标；x, y, z轴的坐标。 最小值：-9999999 最大值：99999999 数组长度：3 - 3 size Array of floats 口袋尺寸大小；x, y, z轴的大小。 最小值：2 最大值：500 数组长度：3 - 3

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 mode 是 String 口袋识别的模式：自动、全局、配体、残基。 枚举值： AUTO GLOBAL LIGAND RESIDUES receptor_file 是 ReceptorDrugFileReq object 受体文件。 ligand_file 否 DrugFile object 配体文件。 residues 否 Array of strings 残基列表，当识别模式为残基时提供。 最小长度：4 最大长度：16 数组长度：1 - 32 表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 表5 DrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值： EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：1 最大长度：2000 format 否 String 文件格式，支持PDB、SDF、MOL2、SMI，仅数据源为RAW时提供。 最小长度：1 最大长度：6 data 否 String 文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000

请求示例 导入用户，用户id为18c10a09-65d5-4fe8-8337-4ce5570b8a4b，角色为ADMIN，作业配额为10，作业超时时长为1天，CPU的核数配额为50，内存的配额为128GB，用户可创建的项目数为2 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/batch-import { "iam_user_id" : "18c10a09-65d5-4fe8-8337-4ce5570b8a4b", "role" : "ADMIN", "settings" : { "job_quota" : 10, "job_timeout" : 1, "cpu_quota" : 50, "mem_quota" : 128, "projects_per_user" : 2 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 iam_user_id 是 String IAM用户id 最小长度：1 最大长度：128 role 是 String 角色类型：管理员(ADMIN)、操作者(OPERATOR) 最小长度：1 最大长度：64 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

请求示例 创建镜像，设置描述、名称、版本、类型、芯片类型 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/images { "description" : "this is a demo image", "name" : "demo-image", "tag" : "v1.0", "type" : "APP", "chip_type" : "X86" }

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/images 表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参数 参数 是否必选 参数类型 描述 description 否 String 描述信息 最小长度：0 最大长度：1024 name 是 String 镜像名称 最小长度：1 最大长度：128 tag 是 String 镜像版本 最小长度：1 最大长度：64 type 否 String 镜像类型。枚举值：APP、NOTEBOOK 枚举值： APP NOTEBOOK chip_type 否 String 镜像芯片类型。枚举值：X86、ARM 枚举值： X86 ARM

响应示例 状态码： 200 OK { "count" : 1, "users" : [ { "id" : "7116d09f88fa41908676fdd4b039...", "name" : "user", "role" : "ADMIN", "status" : "ACTIVE", "email" : "example@huawei.com", "phone" : "12345678910", "areacode" : "0086", "is_domain_owner" : true, "create_time" : "2021-01-15T02:45:38Z", "pwd_status" : true, "update_time" : "2021-01-15T02:45:38Z", "source" : "PLATFORM" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 用户数 users Array of GetUserRsp objects 用户信息列表 表4 GetUserRsp 参数 参数类型 描述 id String 用户id name String 用户名，长度4~31之间，首位不能为数字，特殊字符只能包含下划线“_”、中划线“-”和空格 role String 角色类型：管理员(ADMIN)、操作者(OPERATOR) status String 状态 email String 用户邮箱，需符合邮箱格式 phone String 用户手机号，纯数字，长度小于等于32位。必须与国家码同时存在。 areacode String 国家码。中国大陆为“0086” is_domain_owner Boolean 是否domain用户 create_time String 用户创建时间，UTC时间 pwd_status Boolean 是否需要修改密码 update_time String 更新时间，UTC时间 source String 来源，PLATFORM或者IAM

响应示例 状态码： 200 OK { "count" : 1, "flavors" : [ { "code" : "eihealth.bms.spec.bms2.12xlarge.dgx2", "name" : "eihealth.bms.spec.bms2.12xlarge.dgx2", "ram" : 8192, "vcpus" : 4, "max_rate" : 8000, "min_rate" : 2400, "max_pps" : 800000, "sold_out" : false, "cpu_detail" : "Intel Xeon E5-2667 V4 (2*8core* 3.2 GHz)", "disk_detail" : "SAS SSD:2*800G Raid 1 + NVMe SSD Card1.6T", "memory_detail" : "256GB DDR4 RAM (GB)", "netcard_detail" : "2 x 2*10GE", "cpu_arch" : "x86_64" } ] }

URI GET /v1/{project_id}/system/computing-resources/flavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 availability_zone_id 否 String 可用区 最小长度：1 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 flavors Array of ComputingResourceFlavorsRsp objects 规格列表 表5 ComputingResourceFlavorsRsp 参数 参数类型 描述 code String 规格编码 name String 规格名称 最大长度：64 ram Long 内存 vcpus String vcpus max_rate String 最大带宽 min_rate String 基准带宽 max_pps String 最大收发包能力 sold_out Boolean 是否售罄 az String 可用区 cpu_detail String CPU物理规格描述信息 disk_detail String 磁盘物理规格描述信息 memory_detail String 内存物理规格描述信息 netcard_detail String 网卡物理规格描述信息 cpu_arch String 裸金属服务器的CPU架构类型 gpu_info String GPU信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 mobile 否 String 用户手机号，纯数字，长度小于等于32位，当且仅当重置手机号时传入空串。必须与国家码同时存在。 最小长度：0 最大长度：32 areacode 否 String 国家码，当且仅当重置手机号时传入空串。中国大陆为“0086” 最小长度：0 最大长度：10 email 否 String 用户邮箱，需符合邮箱格式 最小长度：0 最大长度：128 ticket 否 String 预验证凭证 最小长度：0 最大长度：1024

请求示例 修改用户信息，修改邮箱为example@huawei.com，电话为12345678910 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/{user_id} { "mobile" : "12345678910", "areacode" : "0086", "email" : "example@huawei.com", "ticket" : "ticket" }

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 study_id 是 String study_id 最小长度：1 最大长度：128

请求示例 创建药筛作业，指定已创建的流程作业id、数据库模板id、数据库名称、生成结果的相对路径、输出文件类型 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id}/jobs { "workflow_job_id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda", "template_id" : "e1ae25a0-070b-41ca-a1a9-3cb8db39e169", "database_name" : "demo-database", "relative_path" : "docking-summary", "output_file_type" : "csv" }