华为云用户手册

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

响应示例 状态码： 200 OK { "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参数 参数 参数类型 描述 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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 data_event 是 Array of strings 审计数据类型列表 数组长度：0 - 2 枚举值： READ WRITE

URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/project-tracker 表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}/project-tracker 表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参数 参数 是否必选 参数类型 描述 password 否 String 新密码，在8-32位之间支持用户自定义密码长度，至少包含以下四种字符中的两种： 大写字母、小写字母、数字和特殊字符。 最小长度：8 最大长度：32 mobile 否 String 用户手机号，纯数字，长度小于等于32位，当且仅当重置手机号时传入空串。必须与国家码同时存在。 最小长度：0 最大长度：32 areacode 否 String 国家码，当且仅当重置手机号时传入空串。中国大陆为“0086” 最小长度：0 最大长度：10 email 否 String 用户邮箱，需符合邮箱格式 最小长度：0 最大长度：128

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 用户名，长度1~64之间，首位不能为数字，特殊字符只能包含下划线“_”、中划线“-”和空格 最小长度：1 最大长度：64 password 是 String 用户密码，在8-32位之间支持用户自定义密码长度，至少包含以下四种字符中的两种： 大写字母、小写字母、数字和特殊字符。 最小长度：8 最大长度：32 role 是 String 角色类型：管理员(ADMIN)、操作者(OPERATOR) 最小长度：1 最大长度：64 email 否 String 用户邮箱，需符合邮箱格式 最小长度：0 最大长度：128 phone 否 String 用户手机号，纯数字，长度小于等于32位。必须与国家码同时存在。 最小长度：5 最大长度：32 areacode 否 String 国家码。中国大陆为“0086” 最小长度：1 最大长度：10 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

请求示例 创建用户，用户名为example_user，密码为example，角色为ADMIN，邮箱为example@huawei.com，电话为12345678910，作业配额为10，作业超时时长为1天，CPU的核数配额为50，内存的配额为128GB，用户可创建的项目数为2 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users { "name" : "example_user", "password" : "example", "role" : "ADMIN", "email" : "example@huawei.com", "phone" : "12345678910", "areacode" : "0086", "settings" : { "job_quota" : 10, "cpu_quota" : 50, "mem_quota" : 128, "job_timeout" : 1, "projects_per_user" : 2 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 X-Delete-Now 否 Boolean 非核心项目删除立即删除标记 缺省值：false

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表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参数 参数 是否必选 参数类型 描述 original_password 是 String 原始密码 最小长度：0 最大长度：128 new_password 是 String 新密码 最小长度：8 最大长度：32 ticket 否 String 预验证凭证 最小长度：0 最大长度：1024

请求示例 修改用户密码，修改密码Original_Password@为New_Password@ https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/{user_id}/password { "original_password" : "Original_Password@", "new_password" : "New_Password@", "ticket" : "ticket" }

请求示例 创建靶点优化作业，作业名称为demo-job，受体文件为project:/dir/file，配体文件为project:/dir/file，时间步长为2fs，温度为300k，能量最小化步数为10000，nvt为200ps，npt为500ps，平衡步骤模拟时长为50ns。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/target-optimization { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "receptor" : { "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "balanced_charge" : true, "water_model" : "tip3p", "force_field" : "amber99sb", "ion_type" : "NaCl", "ion_concentration" : 0.15 }, "ligand" : { "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "force_field" : "gaff" }, "md_params" : { "timestep_size" : 2, "temperature" : 300, "step_params" : { "energy_minimization_steps" : 10000, "nvt" : 200, "npt" : 500, "simulation_time" : 50 } } }

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

请求参数 表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 是 TargetOptReceptor object 受体文件。 ligand 否 TargetOptLigand object 配体文件。 md_params 否 MdParam object MD参数配置。 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称，取值范围：[5,64]，允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度：5 最大长度：64 labels 否 Array of strings 标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。 最小长度：1 最大长度：32 数组长度：0 - 5 表5 TargetOptReceptor 参数 是否必选 参数类型 描述 file 是 ReceptorDrugFile object 受体文件。 balanced_charge 否 Boolean 是否平衡电荷。 缺省值：true water_model 否 String 水模型, 支持选择spc, spce, tip3p, tip4p, tip5p。 缺省值：tip3p force_field 否 String 蛋白立场，支持选择amber03, amber94, amber96, amber99, amber99sb, amber99sb-ildn, amberGS, charmm27, oplsaa, gromos43a1, gromos43a2, gromos45a3, gromos53a5, gromos53a6, gromos54a7。 缺省值：amber99sb ion_type 否 String 离子种类，支持选择NaCl、MgCl2、None，若设置了平衡电荷不支持选择None。 缺省值：NaCl ion_concentration 否 Float 离子浓度，单位mol/L，若离子种类设置为None离子浓度不支持设置。 最小值：0 最大值：5.0 缺省值：0.15 表6 ReceptorDrugFile 参数 是否必选 参数类型 描述 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 表7 TargetOptLigand 参数 是否必选 参数类型 描述 file 是 ProbeDrugFile object 配体文件。 force_field 否 String 配体力场, 支持选择gaff, gaff2。 缺省值：gaff 表8 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 表9 MdParam 参数 是否必选 参数类型 描述 timestep_size 否 Float MD模拟的时间步长，单位fs，取值范围：大于0，小于等于5。 最小值：0 最大值：5.0 缺省值：2 temperature 否 Float MD模拟的温度，单位K。 最小值：0 最大值：1000.0 缺省值：300 step_params 否 MdStepParam object 计算步骤参数。 表10 MdStepParam 参数 是否必选 参数类型 描述 energy_minimization_steps 否 Integer 能量最小化的步骤。 最小值：1 最大值：50000 缺省值：10000 nvt 否 Float 等温等体步骤模拟的时长，单位ps。 最小值：0 最大值：1000.0 缺省值：200 npt 否 Float 等压等温步骤模拟的时长，单位ps。 最小值：0 最大值：1000.0 缺省值：500 simulation_time 否 Float 平衡步骤模拟的时长，单位ns。 最小值：0 最大值：50.0 缺省值：50

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

URI GET /v1/{project_id}/base-models 表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 sort_dir 否 String 排序规则目前默认时间升序。 缺省值：ASC sort_key 否 String 排序规则目前默认时间升序，支持根据create_time排序。 缺省值：create_time

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 models Array of BaseModelDto objects 模型列表。 count Integer 模型总数。 表5 BaseModelDto 参数 参数类型 描述 name String 模型名称。 id String 模型ID。 create_time String 模型创建时间。 description String 模型描述信息。

响应示例 状态码： 200 OK { "count" : 1, "models" : [ { "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "name" : "demo_name", "description" : "description", "create_time" : "2021-01-30T02:34:36Z" } ] }

响应示例 状态码： 200 OK { "path" : "2022|02|21|eiHealth-project_CloudTrace_cn-north-7_2022-02-21T02-31-09Z_a45fc9849d217b43.json.gz", "name" : "eiHealth-project_CloudTrace_cn-north-7_2022-02-21T02-31-09Z_a45fc9849d217b43.json.gz", "type" : "FILE", "size" : 438, "create_time" : "2022-02-21T02:31:09Z", "download_url" : "https://aos-eihealth-for-trace-***/***60.json.gz" }

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