华为云用户手册

请求示例 创建分子优化作业，作业名称为demo-job，分子SMILES表达式为string，靶点设置的受体文件为project:/test.pdb，口袋中心位置为[0,0,0]，口袋尺寸大小为[500,500,500]，设置弱约束为eye_corrosion，类型为布尔值，值为true，设置强约束为sascore，类型为range，值为[0,1]。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/optimization { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "smiles" : "string", "num_trials" : 500, "binding_sites" : [ { "name" : "target1", "receptor" : { "source" : "PRIVATE", "url" : "project:/test.pdb" }, "engine" : "DSDP", "bounding_box" : { "center" : [ 0, 0, 0 ], "size" : [ 500, 500, 500 ] }, "remove_ion" : false, "remove_water" : false, "remove_ligand" : false } ], "weak_constraints" : [ { "name" : "eye_corrosion", "type" : "bool", "bool" : true } ], "strong_constraints" : [ { "name" : "sascore", "type" : "range", "range" : [ 0, 1 ] } ] }

请求参数 表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 最大长度：512 molecule_file 否 DrugFile object 分子文件。 binding_site 否 BindSiteDto object 受体。 binding_sites 否 Array of BindSiteDto objects 受体列表和受体是二选一的关系，受体列表优先级最高。 数组长度：0 - 2 weak_constraints 否 Array of WeakConstraintDto objects 弱约束集合。 数组长度：0 - 10 strong_constraints 否 Array of StrongConstraintDto objects 强约束集合。 数组长度：0 - 5 sampler_mixin_weight 否 Float 初始化采样权重，参数范围(0.5,1)，不包含0.5和1，默认值为0.6。 最小值：0.5 最大值：1 缺省值：0.6 base_model_id 否 String 基模型ID。 缺省值：pangu-drug-model 最小长度：0 最大长度：128 model_ids 否 Array of strings 模型ID列表。 最小长度：1 最大长度：128 数组长度：0 - 10 num_trials 否 Integer 生成分子数量。 最小值：0 最大值：5000 缺省值：5000 表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 DrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源：外部网络数据（如R CS B在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）、源数据。 枚举值： 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 表6 BindSiteDto 参数 是否必选 参数类型 描述 name 否 String 靶点名称，只能设置为target1或者target2。 最小长度：1 最大长度：128 receptor 是 ReceptorDrugFile object 受体文件。 engine 否 String 引擎，支持DSDP、AUTODOCK_VINA，默认值为AUTODOCK_VINA。 最小长度：0 最大长度：15 docking_type 否 String 对接类型，仅支持POCKET_DOCKING。 缺省值：POCKET_DOCKING 最小长度：0 最大长度：15 bounding_box 否 BoundingBoxDto object 结合口袋，包含口袋中心位置和尺寸大小。 remove_ion 否 Boolean 去除受体中的离子。 缺省值：true remove_water 否 Boolean 去除受体中的水分子。 缺省值：true remove_ligand 否 Boolean 去除受体中的配体分子。 缺省值：true add_hydrogen 否 Boolean 增加氢原子。 缺省值：false 表7 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 表8 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 表9 WeakConstraintDto 参数 是否必选 参数类型 描述 id 否 String 自定义模型ID，仅弱约束为模型时填写。 最小长度：1 最大长度：128 name 否 String 属性名称。 最小长度：1 最大长度：128 type 是 String 属性约束类型。 枚举值： bool range struct minimize maximize interaction bool 否 Boolean 属性约束类型bool的参数。 range 否 Array of floats 属性约束类型range的参数。 最小值：-9999 最大值：9999 数组长度：2 - 2 struct 否 StructureConstraintParamsDto object 结构约束参数。 quantiles 否 Array of floats 属性约束类型minimize和maximize的参数。 最小值：0.0 最大值：1.0 数组长度：2 - 2 interaction 否 InteractionConstraintDto object 相互作用力约束参数。 表10 StrongConstraintDto 参数 是否必选 参数类型 描述 id 否 String 自定义模型ID，仅强约束为模型时填写。 最小长度：1 最大长度：128 name 否 String 属性名称。 最小长度：1 最大长度：128 type 是 String 属性约束类型。 枚举值： bool range struct interaction bool 否 Boolean 属性约束类型bool的参数。 range 否 Array of floats 属性约束类型range的参数。 最小值：-9999 最大值：9999 数组长度：2 - 2 struct 否 StructureConstraintParamsDto object 结构约束参数。 interaction 否 InteractionConstraintDto object 相互作用力约束参数。 表11 StructureConstraintParamsDto 参数 是否必选 参数类型 描述 structs 是 Array of strings 子结构SMILES。 最小长度：1 最大长度：120 数组长度：1 - 8 exclusive 是 Boolean 是否排除子结构。 operator 否 String 多个子结构之间的逻辑关系。 枚举值： or and 表12 InteractionConstraintDto 参数 是否必选 参数类型 描述 interactions 是 Array of Interaction objects 相互作用力列表。 数组长度：1 - 8 exclusive 是 Boolean 是否排除指定的约束作用力。 operator 否 String 多个子结构之间的逻辑关系。 枚举值： or and 表13 Interaction 参数 是否必选 参数类型 描述 binding_site 是 String 靶点，只支持target1或target2。 最小长度：1 最大长度：128 type 是 String 相互作用力类型，支持氢键、疏水作用、盐桥、π-π堆积、π-阳离子。 枚举值： hydrogen_bond hydrophobic_action salt_bridge pi_stacking pi_cation amino_acid 是 String 氨基酸。 最小长度：4 最大长度：16

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/optimization 表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}/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

响应示例 状态码：200 OK { "id" : "DE-7d558ef8-c73d-11ea-964c-0255ac100033", "name" : "notebook-example", "description" : "notebook description in here", "creator" : "notebook_creator", "url" : "https://x.x.x.x:0000/0951eb641.../notebook/e4a3b97a.../services/notebook", "flavor" : { "cpu" : "1", "gpu" : "0", "gpu_type" : "GPU", "memory" : "100" }, "status" : "Running", "image" : { "image_type" : "SYSTEM", "image_info" : { "source_project_name" : "eihealth-project", "image_name" : "eihealth-notebook", "image_tag" : "3.1.0-latest", "profile" : "PY3" } }, "storages" : [ { "path" : "project_name:/example" } ], "create_time" : "2020-09-10T10:07:17Z", "update_time" : "2020-09-10T10:07:17Z", "failed_message" : "failed massage in here" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 作业基本信息。 file 是 ClusteringDrugFile 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 ClusteringDrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源：用户私有数据中心、承载租户公共数据（含样例/公共库）、源数据。 枚举值： PRIVATE PUBLIC RAW url 否 String 文件URL，当数据源为外部网络数据时为https地址，为用户私有数据中心时为空间路径，为公共数据场景时为obs地址。 最小长度：1 最大长度：2000 format 否 String 文件格式，支持SMI，仅数据源为RAW时提供。 最小长度：1 最大长度：6 data 否 String 文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000

请求示例 创建聚类分析作业，输入方式为分子文件，作业名称为demo-job。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/{job_id}/clustering { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" } }

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

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

请求示例 受体信息解析，如果有多个受体蛋白则只处理第一个，如果一个受体蛋白里结合了多个配体，则最多只处理前10个。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/receptor/info { "source" : "RAW", "url" : "https://files.rcsb.org/download/1TQN.pdb", "format" : "PDB", "data" : "MODEL1.xxxxxxx.END" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 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 add_hydrogen 否 Boolean 增加氢原子。 缺省值：true

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/receptor/info 表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参数 参数 是否必选 参数类型 描述 scope 是 String 接收范围（不接收消息（none）、仅接收自己操作的消息（mine）、接收全部消息（all））。 最小长度：1 最大长度：128 resource_types 否 Array of strings 资源类型。 最小长度：1 最大长度：128 数组长度：0 - 10 language 否 String 枚举值： en_us zh_cn

URI GET /v1/{project_id}/system/autoscaler/scale-out-policies/{id}/computing-resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 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参数 参数 是否必选 参数类型 描述 spec_code 是 String 规格编码。 最小长度：1 最大长度：128 disk_space 否 Integer 磁盘存储空间，该字段暂不生效。 最小值：40 最大值：1000 disk_encrypt 是 Boolean 磁盘是否加密。

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

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

请求示例 设置空间级权限控制策略，设置空间级数据可删除，可下载、可分享、启动加密模式。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/policy { "data_delete" : true, "data_download" : true, "data_encrypted" : true, "data_share" : true }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 data_delete 否 Boolean 空间级删除策略（true：允许空间数据删除操作，false：不允许删除操作，默认为true）。 缺省值：true data_download 否 Boolean 空间级下载策略（true：允许空间数据下载操作，false：不允许下载操作，默认为true）。 缺省值：true data_encrypted 否 Boolean 空间级加密策略（true：允许空间 数据加密 操作，false：不允许加密操作，默认为false）。 缺省值：false data_share 否 Boolean 空间级分享策略（true：允许空间数据拷贝、引用操作，false：不允许拷贝、引用操作，默认为true）。 缺省值：true

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

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

响应参数 状态码：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 CSS集群是否可用。

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

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

请求参数 表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://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups/{backup_id}/restore { "target_folder" : "folder-test/", "target_project_id" : "0e228eb7-df7f-49fb-844e-84bb8df9a71a" }

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