华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 method 是 String 差异计算方法：RMSD、EMD。 枚举值： RMSD EMD file 是 DrugFile object 配体文件。 ref_file 是 DrugFile object 参考的配体文件。 表4 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

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

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/retry 表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 FormData参数 参数 是否必选 参数类型 描述 params 否 File 流程参数列表文件，取值范围[0, 10M]

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

URI GET /v1/{project_id}/customer-buckets/{bucket_name}/objects 表1 路径参数 参数 是否必选 参数类型 描述 bucket_name 是 String 桶名称 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 限制量，单次查询总量[1, 1000]，默认100 最小值：1 最大值：1000 缺省值：100 offset 否 Integer 偏移量，查询起始偏移，默认为0 最小值：0 最大值：100000000 缺省值：0 path 否 String 子路径 最小长度：0 最大长度：2000 search_key 否 String 查询关键词 最小长度：0 最大长度：2000

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 数据（文件夹、文件）总数量 objects Array of BucketObjectDto objects 数据列表 表5 BucketObjectDto 参数 参数类型 描述 path String 对象全路径（项目名称:/路径） name String 名称 type String 类型 枚举值： FILE FOLDER size Long 大小 create_time String 创建时间

响应示例 状态码： 200 OK { "count" : 1, "objects" : [ { "path" : "bucket:/test.txt", "name" : "test.txt", "type" : "FILE", "size" : 1024, "create_time" : "2021-02-01T14:25:34Z" } ] }

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，cn-north-4为project的名称，获取方法请参见获取用户名、账号名和项目name。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 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 } } } } 到这里为止这个请求需要的内容就齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP请求方法 方法 说明 GET 请求服务器返回指定资源. PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为 “POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json X-Auth-Token: ABCDEFJ....

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 请求URI 参数 说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器域名或IP，不同服务在不同区域时，对应Endpoint不同，可以从终端节点中获取。 例如EIHealth服务在“华北-北京四”区域的Endpoint为“eihealth.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如，您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 为查看方便，服务每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 表3 公共请求消息头 参数名 说明 是否必选 示例 Content-type 消息体的类型（格式），默认取值为“application/json”。 是 application/json 例如，对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data_points Array of DataPointDto objects 监控数据列表 metric_name String 监控指标名称 resource_id String 监控资源id 表5 DataPointDto 参数 参数类型 描述 timestamp Long 时间戳 unit String 数据单位 value Number 统计结果

URI GET /v1/{project_id}/metric-data 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 from_time 否 Long 查询监控数据起始时间，UNIX时间戳，单位毫秒，不填时默认为当前时间 to_time 否 Long 查询数据截止时间，UNIX时间戳，单位毫秒，不填时默认为当前时间 period 否 String 监控数据周期。枚举值，取值范围：real_time（实时数据）、five_minutes（5分钟粒度）、fifteen_to_twenty_minutes（15-20分钟粒度）、one_hour（1小时粒度），不填时默认为real_time 缺省值：real_time method 否 String 统计方法。枚举值，取值范围：max（最大值）、min（最小值）、average（平均值），不填时默认为max 缺省值：max metric_name 是 String 查询的监控指标名称 resource_id 否 String 查询的监控资源对象id，当查询存储资源和计算节点资源中的集群监控数据时，不需要填写资源id 最小长度：1 最大长度：128 device_id 否 String 显卡id，仅查询裸金属节点的gpu监控时，需要指定 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 role 是 String 项目角色。 枚举值： Administrator Developer Uploader Viewer

URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 user_id 是 String 更新或者添加项目成员角色的用户id 最小长度：1 最大长度：128

响应示例 状态码： 200 OK { "count" : 1, "jobs" : [ { "id" : "78dfce53-0303-4b46-a2d9-4a067812b289", "workflow_job_id" : "78dfce53-0303-4b46-a2d9-4a067812b289", "name" : "study-job", "status" : "RUNNING", "template_id" : "24dfce53-0303-4b46-a2d9-4a067812b289", "database_name" : "demo-database", "database_id" : "4f7fce53-0303-4b46-a2d9-4a067812b289", "relative_path" : "/docking-summary", "output_file_type" : "csv", "workflow_name" : "docking-summary", "label" : "small-molecular-chemicals", "create_time" : "2021-02-22T07:07:41Z", "update_time" : "2021-02-22T07:07:41Z" } ] }

URI GET /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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 作业总数 jobs Array of StudyJobRsp objects 作业列表 表4 StudyJobRsp 参数 参数类型 描述 id String study作业id workflow_job_id String workflow作业id name String 作业名称 status String 作业状态 template_id String 生成study作业结果的模板id database_name String study作业结果的数据库实例名称 database_id String study作业结果的数据库实例id relative_path String 生成study作业结果的文件的相对路径 output_file_type String 生成study作业结果的文件的类型 workflow_name String 使用的workflow名称 label String 使用的workflow标签 create_time String 作业创建时间 update_time String 作业更新时间

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data_delete Boolean 项目级删除策略（true：允许项目数据删除操作，false：不允许删除操作，默认为true） data_download Boolean 项目级下载策略（true：允许项目数据下载操作，false：不允许下载操作，默认为true） data_encrypted Boolean 项目级加密策略（true：允许项目数据加密操作，false：不允许加密操作，默认为false） data_share Boolean 项目级分享策略（true：允许项目数据拷贝/引用操作，false：不允许拷贝/引用操作，默认为true）

URI GET /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

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

请求示例 引用项目数据，引用如下项目的test1和test2/test.txt数据。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/quote { "quote_project_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "sub_paths" : [ "test1/", "test2/test.txt" ] } { "quote_project_id" : "OBS:obs-bucket-name", "sub_paths" : [ "test1/", "test2/test.txt" ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 quote_project_id 是 String 引入项目ID 最小长度：1 最大长度：128 sub_paths 是 Array of strings 引入路径集 最小长度：0 最大长度：2000 数组长度：1 - 50

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 overwrite 否 Boolean 执行策略（true：全部覆盖，false：全部跳过，默认为true） 缺省值：true target_folder 否 String 目标文件夹 最小长度：0 最大长度：2000 target_project_id 是 String 目标项目ID 最小长度：1 最大长度：128

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

请求示例 恢复归档文件，恢复到如下项目的folder-test目录中 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups/{backup_id}/restore { "target_folder" : "folder-test/", "target_project_id" : "0e228eb7-df7f-49fb-844e-84bb8df9a71a" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 method 是 String 认证方式:sms，email，vmfa 最小长度：1 最大长度：128

URI PUT /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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 type 否 String 镜像类型。枚举值：APP、NOTEBOOK 枚举值： APP NOTEBOOK description 否 String 描述信息 最小长度：0 最大长度：1024 chip_type 否 String 镜像芯片类型。枚举值：X86、ARM 枚举值： X86 ARM