华为云用户手册

请求示例 创建靶点口袋分子设计作业，作业名称为demo-job， 受体文件为project:/dir/file，小分子片段文件为project:/dir/file，自定义属性预测id为xxxxxx，分子量约束为200-600，预期的最大输出为5000个。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-mol-design { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "receptor" : { "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "bounding_box" : { "center" : [ 0, 0, 0 ], "size" : [ 10, 10, 10 ], "padding" : 10 }, "remove_water" : false, "remove_ion" : false }, "ligands" : [ { "source" : "PRIVATE", "url" : "project:/dir/file" } ], "model_ids" : [ "xxxxxx" ], "molecular_weight" : [ 200, 600 ], "optimization_mode" : "generation", "base_model_id" : "PanguDrug3D" }

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

响应示例 状态码：201 CREATED 创建靶点口袋分子设计作业成功。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" } 创建靶点口袋分子设计作业成功，当前运行作业数已达配额限制，此作业会等待。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }

URI GET /v1/{project_id}/drug/databases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 search_key 否 String 数据库名称搜索。 最小长度：0 最大长度：128 type 否 String 数据库类型搜索。 sort_key 否 String 排序规则，目前默认时间降序，支持根据create_time|update_time。 sort_dir 否 String 排序规则，目前默认时间降序。 缺省值：desc limit 否 Integer 限制量，单次查询总量，必须由数字组成，默认为100，取值范围[1,1000]。 最小值：1 最大值：1000 缺省值：100 offset 否 Integer 偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围[0,100000000]。 最小值：0 最大值：100000000 缺省值：0

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 databases Array of DrugDatabaseDto objects 数据库列表。 count Integer 数据库总数。 cur_user_count Integer 当前用户数据库总数。 表5 DrugDatabaseDto 参数 参数类型 描述 id String 数据库ID。 name String 数据库名称。 type String 数据库类型。 status String 数据库状态。 description String 数据库描述。 create_time String 数据库创建时间。 update_time String 数据库更新时间。 creator String 创建数据库的用户名称。 failed_message String 失败提示，当作业执行失败时会返回。 css_id String CSS 集群ID。 css_name String CS S集群名称。 files Array of DetailDatabaseFile objects 数据库文件列表。 columns Array of strings 数据库列名。 shareable Boolean 是否打开组织共享。 data_num Integer 分子数量。 表6 DetailDatabaseFile 参数 参数类型 描述 source String 数据库文件来源。 枚举值： public private url String 文件URL，用户私有数据中心为项目路径、公共数据场景为OBS地址。 最小长度：1 最大长度：2000 eihealth_project_id String 数据库文件所在空间ID，仅文件为数据中心时填写。 最小长度：1 最大长度：128 status String 数据库文件写入状态。 failed_reason String 失败原因。

响应示例 状态码：200 OK { "count" : 1, "cur_user_count" : 1, "databases" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "database_name", "status" : "ACTIVE", "description" : "数据库ID。", "create_time" : "2024-01-30T02:34:36Z", "update_time" : "2024-01-30T02:53:26Z", "creator" : "demo_user_name", "failed_message" : "null", "files" : [ { "source" : "public", "url" : "project:/test/url.csv", "eihealth_project_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "status" : "SUC CES S" } ], "columns" : [ "SMILES", "NAME" ], "shareable" : true, "data_num" : 500 } ] }

响应示例 状态码：200 OK { "count" : 1, "flavors" : [ { "code" : "eihealth.dbm.spec.basic", "name" : "string", "cpu" : 0, "ram" : 0, "max_connections" : 0, "disk_space" : 0, "sold_out" : true } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 count Integer 个数。 flavors Array of DatabaseFlavorRsp objects 规格列表。 表4 DatabaseFlavorRsp 参数 参数类型 描述 code String 规格编号。 name String 规格名称。 cpu Integer 核数。 ram Integer 内存。 max_connections Integer 最大连接数。 disk_space Integer 存储空间。 sold_out Boolean 是否售罄。

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

响应参数 状态码：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）。

请求示例 创建分子对接作业，作业名称为demo-job， 受体文件为project:/dir/file，口袋中心位置的值为[0,0,0]，口袋尺寸大小为[10,10,10]，去除受体的水分子。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/docking { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "receptors" : [ { "receptor" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "bounding_box" : { "center" : [ 0, 0, 0 ], "size" : [ 10, 10, 10 ] }, "remove_water" : true, "remove_ion" : false, "remove_ligand" : false } ], "ligands" : [ { "ligand" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "count" : 100 } ] }

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/docking 表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参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 创建药物作业基本信息。 receptors 是 Array of DockingReceptorDto objects 受体文件列表。 数组长度：1 - 20 ligands 是 Array of LigandDto objects 配体文件列表，当前仅支持1个。 数组长度：1 - 1 engine 否 String 引擎，仅支持VINA，默认值为VINA，支持DSDP、AUTODOCK_VINA、SIMILAR_DOCKING，默认值为AUTODOCK_VINA。 最小长度：0 最大长度：15 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称，长度范围[5,64]，允许大小写字母、数字、空格、下划线（_）和中划线（-），只能以数字或字母开头。 最小长度：5 最大长度：64 labels 否 Array of strings 标签，长度范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线（_）和中划线（-），且不能以空格开头或者结尾。 最小长度：1 最大长度：32 数组长度：0 - 5 upstream_job_info 否 String 上游作业信息。 最小长度：1 最大长度：10240 表5 DockingReceptorDto 参数 是否必选 参数类型 描述 receptor 是 ReceptorDrugFile object 受体文件。 bounding_box 是 BoundingBoxDto object 结合口袋，包含口袋中心位置和尺寸大小。 remove_ion 否 Boolean 去除受体中的离子。 缺省值：true remove_water 否 Boolean 去除受体中的水分子。 缺省值：true remove_ligand 否 Boolean 去除受体中的配体分子。 缺省值：true add_hydrogen 否 Boolean 增加氢原子。 缺省值：false docking_type 否 String 对接类型，支持BLIND_DOCKING、POCKET_DOCKING。 缺省值：POCKET_DOCKING 最小长度：0 最大长度：15 reference_file 否 ReferenceLigandFile object 模板配体文件，仅引擎为SIMILAR_DOCKING时提供。 表6 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 表7 BoundingBoxDto 参数 是否必选 参数类型 描述 center 是 Array of doubles 口袋中心坐标，x、y、z轴的坐标。 最小值：-9999999 最大值：99999999 数组长度：3 - 3 size 是 Array of floats 口袋尺寸大小，x、y、z轴的大小。 最小值：2 最大值：500 数组长度：3 - 3 padding 否 Float 填充。 最小值：0 最大值：20 表8 ReferenceLigandFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）、源数据。 枚举值： EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL，当数据源为外部网络数据时为https地址，为用户私有数据中心时为空间路径，为公共数据场景时为obs地址。 最小长度：1 最大长度：2000 format 否 String 文件格式，支持PDB、SDF、MOL2、SMI、CSV等，仅数据源为RAW时提供。 最小长度：1 最大长度：6 data 否 String 文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000 表9 LigandDto 参数 是否必选 参数类型 描述 ligand 是 DrugFile object 配体文件。 count 是 Integer 计算个数。 最小值：1 最大值：1000000 表10 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

请求示例 创建批量下载任务。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/toolkit/batch_download { "job_id" : "1296790078dbc", "mode" : "MOL", "selected" : [ 1, 3, 5, 7 ], "job_result_url" : "ch-test:/job-results/docking/Molecule Docking-20230825-conformation-test-8f8a/result.json" }

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/toolkit/batch-download 表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参数 参数 是否必选 参数类型 描述 job_id 是 String 作业ID。 最小长度：1 最大长度：128 job_result_url 是 String 作业结果文件URL。 最小长度：1 最大长度：2000 mode 是 String 下载类型：MOL（小分子）、COMPLEX（复合物）。 最小长度：3 最大长度：7 format 否 String 文件格式：pdb、sdf（仅下载小分子时支持此格式） 缺省值：pdb 最小长度：3 最大长度：6 selected 是 Array of integers 选中下载的分子下标。 最小值：0 最大值：1000000 数组长度：1 - 10000

请求参数 表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

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

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

请求参数 表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 upstream_job_info 否 String 上游作业信息。 最小长度：1 最大长度：10240 表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

请求示例 创建靶点口袋发现作业，作业名称为demo-job， 受体文件为project:/dir/file，时间步长为0.001ps，最小化步数为20000，预平衡时间为100ps，口袋发现时长为50ns，表面原子离散点数量为30，探针半径1.4A。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/pocket-detection { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "receptor" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "ligand" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "params" : { "timestep_size" : 0.001, "num_minimization_steps" : 20000, "pre_equilibrium_time" : 100, "pocket_detection_time" : 50, "num_surface_points" : 30, "probe_radius" : 1.4 } }

响应示例 状态码：201 CREATED 创建靶点口袋发现作业成功。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" } 创建靶点口袋发现作业成功，当前运行作业数已达配额限制，此作业会等待。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }

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

响应示例 状态码：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" } ] }

响应参数 状态码：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 归档人员姓名。

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）。

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

响应示例 状态码：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 执行时间。