华为云用户手册

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

响应示例 状态码： 200 OK { "basic_info" : { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "labels" : [ "labelA", "labelB" ], "status" : "FINISHED", "type" : "SEARCH", "create_time" : "2021-01-30T02:34:36Z", "start_time" : "2021-01-30T02:34:37Z", "finish_time" : "2021-01-30T02:53:26Z", "failed_message" : "null", "user_name" : "demo-user-name", "output_dir" : "job-analysis/job-name" }, "smiles" : "string", "top_n" : 100, "databases" : [ "databaseA", "databaseB" ], "custom_databases" : [ "custom_databaseA_id", "custom_databaseB_id" ], "search_method" : [ "ECFP_4" ] }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 basic_info DrugJobDto object 作业基本信息。 smiles String 分子SMILES表达式。 最小长度：1 最大长度：1024 scaffold String 分子骨架表达式。 最小长度：1 最大长度：1024 top_n Integer 生成分子数量。 最小值：0 最大值：1000 databases Array of strings 可供搜索分子的公共数据库名称列表。 最小长度：1 最大长度：128 数组长度：0 - 10 custom_databases Array of strings 可供搜索分子的自定义数据库名称列表。 最小长度：1 最大长度：128 数组长度：0 - 10 models Array of BasicDrugModel objects 模型信息。 search_method String 分子搜索方法。 枚举值： ECFP_4 SCAFFOLD part_failed_reason Array of FailedReasonRecord objects 部分失败原因和数量。 表4 DrugJobDto 参数 参数类型 描述 id String 作业id。 name String 作业的名称，取值范围：[1,63]，允许大小写字母、数字、以及特殊字符中划线(-)。 labels Array of strings 作业标签。 status String 作业状态。 type String 作业类型。 create_time String 作业创建时间。 finish_time String 作业结束时间。 start_time String 作业开始时间。 failed_message String 失败提示，当作业执行失败时会返回。 user_name String 创建任务的用户名称。 output_dir String 作业结果输出目录。 expect_charge_num Double 预估功能调用消耗次数。 real_charge_num Double 实际功能调用消耗次数。 progress Progress object 作业进度信息。 表5 Progress 参数 参数类型 描述 overall Float 整体进度。 estimated_finish_time Long 预计结束时间，毫秒。 表6 BasicDrugModel 参数 参数类型 描述 id String 模型ID。 task_id String 任务ID。 name String 模型名称。 creator String 模型创建者。 type String 模型类型。 value_range ValueRange object 区间上下限，仅回归型存在。 description String 模型描述信息。 表7 ValueRange 参数 参数类型 描述 lower Float 区间下限，仅回归型存在。 upper Float 区间上限，仅回归型存在。 表8 FailedReasonRecord 参数 参数类型 描述 reason String 失败原因。 count Integer 失败数量。

响应示例 状态码： 200 OK [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "database_name", "status" : "ACTIVE", "description" : "description", "create_time" : "2024-01-30T02:34:36Z", "update_time" : "2024-01-30T02:53:26Z", "creator" : "demo_user_name", "failed_message" : "null", "css_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2", "css_name" : "css_name", "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 表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 css集群名称。 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 失败原因

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限， 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 css_id 是 String 集群id。 最小长度：1 最大长度：128 user_name 是 String 集群用户账号。 最小长度：4 最大长度：32 user_pwd 是 String 集群用户密码，长度限制为[8,32]。 最小长度：8 最大长度：32

请求示例 绑定 CSS 资源，选择id为2f042ad4-6aca-11ed-b7f6-fa163e504fdd的 CS S资源，集群管理员为admin，密码为user_pwd。 https://{endpoint}/v1/{project_id}/drug/css-clusters { "css_id" : "2f042ad4-6aca-11ed-b7f6-fa163e504fdd", "user_name" : "admin", "user_pwd" : "user_pwd" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取oke n接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 file 是 DatabaseFile object 数据库文件。 description 否 String 数据库描述。 最小长度：0 最大长度：1024 表4 DatabaseFile 参数 是否必选 参数类型 描述 source 是 String 数据库文件来源。 枚举值： public private url 是 String 文件URL，用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：1 最大长度：2000 eihealth_project_id 否 String 数据库文件所在项目id，仅文件为数据中心时填写。 最小长度：1 最大长度：128

请求示例 数据库追加文件，追加数据为project:/file/test.csv，修改描述为simple database。 https://{endpoint}/v1/{project_id}/drug/drug-database/{database_id} { "description" : "simple database", "file" : { "source" : "PRIVATE", "url" : "project:/file/test.csv", "eihealth_project_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" } }

请求参数 表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}/css/clusters 表1 路径参数 参数 是否必选 参数类型 描述 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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 css_clusters Array of TermTenantCssClusterDto objects 最终租户CSS集群列表。 count Integer 最终租户css集群总数。 表5 TermTenantCssClusterDto 参数 参数类型 描述 css_id String css集群id。 name String css集群名称。 is_active Boolean 集群是否可用。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 labels 否 Array of strings 标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者尾。 最小长度：1 最大长度：32 数组长度：0 - 5

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

请求示例 创建分子搜索作业，作业名称为demo-job，分子SMILES表达式为string,从数据库中找到最相似top100的分子。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/search { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "smiles" : "string", "top_n" : 100, "databases" : [ "databaseA", "databaseB" ], "custom_databases" : [ "custom_databaseA_id", "custom_databaseB_id" ], "model_ids" : [ "model_id" ], "search_method" : [ "ECFP_4" ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 创建药物作业基本信息。 smiles 是 String 分子SMILES表达式。 最小长度：1 最大长度：1024 scaffold 否 String 分子骨架表达式。 最小长度：1 最大长度：1024 top_n 否 Integer 最相似的top_n个。 最小值：1 最大值：1000 缺省值：100 databases 否 Array of strings 可供搜索分子的公共数据库名称列表。 最小长度：1 最大长度：128 数组长度：0 - 10 custom_databases 否 Array of strings 可供搜索分子的自定义数据库id列表。 最小长度：1 最大长度：128 数组长度：0 - 10 model_ids 否 Array of strings 模型id列表。 最小长度：1 最大长度：128 数组长度：0 - 10 search_method 否 String 分子搜索方法。 枚举值： ECFP_4 SCAFFOLD 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称，取值范围：[5,64]，允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度：5 最大长度：64 labels 否 Array of strings 标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。 最小长度：1 最大长度：32 数组长度：0 - 5

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/search 表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}/drug-common/toolkit/batch-download/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID。 最小长度：1 最大长度：128 task_id 是 String 下载任务ID。 最小长度：1 最大长度：128

请求示例 测试CSS资源连通性，选择id为2f042ad4-6aca-11ed-b7f6-fa163e504fdd的CSS资源，集群管理员为admin，密码为user_pwd。 https://{endpoint}/v1/{project_id}/drug/css-clusters { "css_id" : "2f042ad4-6aca-11ed-b7f6-fa163e504fdd", "user_name" : "admin", "user_pwd" : "user_pwd" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 css_id 是 String 集群id。 最小长度：1 最大长度：128 user_name 是 String 集群用户账号。 最小长度：4 最大长度：32 user_pwd 是 String 集群用户密码，长度限制为[8,32]。 最小长度：8 最大长度：32

请求示例 创建数据库，数据库名称为database_name，选择css集群，上传项目桶中file/test.csv的数据库数据，设置列名为SMILES和NAME，打开共享开关。 https://{endpoint}/v1/{project_id}/drug/drug-database { "name" : "database_name", "css_id" : "2f042ad4-6aca-11ed-b7f6-fa163e504fdd", "description" : "simple database", "file" : { "source" : "PRIVATE", "url" : "project:/file/test.csv", "eihealth_project_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" }, "columns" : [ "SMILES", "NAME" ], "shareable" : true }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 数据库名称，长度为5-32个字符，首位需以小写英文字母开头，仅可以使用小写字母、数字、下划线“_”和中划线“-”。 最小长度：5 最大长度：32 description 否 String 数据库描述。 最小长度：0 最大长度：1024 css_id 是 String css集群id。 最小长度：1 最大长度：128 file 是 DatabaseFile object 数据库文件。 columns 是 Array of strings 数据文件列名。 最小长度：1 最大长度：128 数组长度：2 - 12 shareable 否 Boolean 是否打开组织共享。 缺省值：false 表4 DatabaseFile 参数 是否必选 参数类型 描述 source 是 String 数据库文件来源。 枚举值： public private url 是 String 文件URL，用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：1 最大长度：2000 eihealth_project_id 否 String 数据库文件所在项目id，仅文件为数据中心时填写。 最小长度：1 最大长度：128

请求示例 创建分子或分子复合物批量下载任务。 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 selected 是 Array of integers 选中下载的分子下标。 最小值：0 最大值：1000000 数组长度：1 - 10000

URI GET /v1/{project_id}/drug/css-clusters 表1 路径参数 参数 是否必选 参数类型 描述 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

响应示例 状态码： 200 OK { "count" : 1, "css_clusters" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "css_name", "storage" : 40, "import_time" : "2024-01-01T14:25:50Z" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 css_clusters Array of CssClusterDto objects CSS集群列表。 count Integer css集群总数。 表5 CssClusterDto 参数 参数类型 描述 id String 已绑定的集群id。 name String css集群名称。 storage Integer css集群总存储。 import_time String css集群导入时间。