华为云用户手册

  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/generation 表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}/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 表3 响应Body参数 参数 参数类型 描述 basic_info 表14-12 object 作业基本信息。 receptors Array of 表14-14 objects 受体文件列表。 数组长度:1 - 100 ligands Array of 表14-15 objects 小分子。 数组长度:1 - 1 表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 表14-13 object 作业进度信息。 表5 Progress 参数 参数类型 描述 overall Float 整体进度。 estimated_finish_time Long 预计结束时间,毫秒。 表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 MoleculeFileDto 参数 参数类型 描述 file 表14-16 object 分子文件。 count Integer 分子个数。 最小值:1 最大值:1000000 表8 MoleculeFile 参数 参数类型 描述 source String 文件来源,支持用户私有数据中心、公共数据和源数据。 最小长度:1 最大长度:8 url String 文件URL,用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 format String 文件格式,支持PDB、SDF、MOL2、SMI,仅数据源为RAW时提供。 最小长度:1 最大长度:6 data String 文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000
  • 响应示例 状态码: 200 OK { "basic_info" : { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-job", "labels" : [ "labelA", "labelB" ], "status" : "FINISHED", "type" : "OPTIMIZATION", "create_time" : "2021-01-30T02:34:36Z", "finish_time" : "2021-01-30T02:53:26Z", "failed_message" : "null", "user_name" : "demo-user-name", "output_dir" : "job-analysis/job-name", "expect_charge_num" : 1, "real_charge_num" : 1 }, "receptors" : [ { "source" : "PRIVATE", "url" : "project:/dir/file" } ], "ligands" : [ { "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "count" : 10000 } ] }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/cpi/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/transfer 表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参数 参数 是否必选 参数类型 描述 user_id 是 String 转移用户id 最小长度:1 最大长度:64
  • 响应示例 状态码: 200 OK [ { "id" : "0era3396d980d45f1fJ3DGW345af8", "name" : "demo-user", "status" : "SUC CES S" } ] 状态码: 207 MULTI_STATUS [ { "id" : "0era3396d980d45f1fJ3DGW345af8", "name" : "demo-user", "status" : "FAILED", "failed_reason" : "Internal error." } ]
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchDeleteMemberRsp objects OK 表6 BatchDeleteMemberRsp 参数 参数类型 描述 id String 用户id name String 用户名 status String 删除结果 failed_reason String 失败原因 状态码: 207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchDeleteMemberRsp objects MULTI_STATUS 表8 BatchDeleteMemberRsp 参数 参数类型 描述 id String 用户id name String 用户名 status String 删除结果 failed_reason String 失败原因
  • 请求示例 批量移除项目成员,指定需要移除的成员的用户id https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/batch-delete { "members" : [ { "user_id" : "0era3396d980d45f1fJ3DGW345af8" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 members 是 Array of MemberDto objects 删除用户列表 数组长度:1 - 5 表4 MemberDto 参数 是否必选 参数类型 描述 user_id 是 String 用户id 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/batch-delete 表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参数 参数 是否必选 参数类型 描述 description 否 String 项目描述 最小长度:0 最大长度:1024 name 是 String 项目名称 最小长度:3 最大长度:45 tags 否 Array of strings 标签 最小长度:1 最大长度:32 数组长度:0 - 5 is_core 否 Boolean 是否核心项目 缺省值:true is_new_bucket 否 Boolean 是否新桶, 仅气象支持该字段 bucket_name 否 String 桶名, 仅气象支持该字段 最小长度:3 最大长度:63
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 operation String 是否开启资源配额限制 枚举值: OPEN CLOSE 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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 operation 是 String 是否开启资源配额限制 枚举值: OPEN CLOSE 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
  • 请求示例 更新用户设置,设置开启资源配额限制,设置作业配额为10,作业超时时长为1天,CPU的核数配额为50,内存的配额为128GB,用户可创建的项目数为2 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/{user_id}/settings { "operation" : "OPEN", "settings" : { "job_quota" : 10, "job_timeout" : 1, "cpu_quota" : 50, "mem_quota" : 128 } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 项目描述 最小长度:0 最大长度:1024 status 否 String 项目状态。枚举值:ACTIVE、INACTIVE 枚举值: ACTIVE INACTIVE tags 否 Array of strings 项目标签 最小长度:1 最大长度:32 数组长度:0 - 5 is_core 否 Boolean 是否为核心项目标记 storage_quota 否 Long 项目数据容量配额,单位为字节,范围为1073741824-11258999068426240,-1表示无容量限制 最小值:-1 最大值:11258999068426240
  • 请求示例 更新项目,修改项目描述、标签,将项目更新为可用状态 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id} { "description" : "this is a demo project", "status" : "ACTIVE", "tags" : [ "tag" ] }
  • URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 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
  • 请求参数 表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
  • 请求参数 表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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 X-Bucket-Name 否 String X-Bucket-Name 最小长度:1 最大长度:128 X-Namespace-Name 否 String X-Namespace 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 项目id name String 项目名称 obs_bucket_name String 项目桶名 swr_namespace String 项目组织名 creator String 项目所有者 role String 当前用户在该项目上的角色 roles Array of ProjectRoleRsp objects 项目角色列表 size Long 项目桶存储量 status String 项目状态 tags Array of strings 标签列表 description String 项目描述 create_time String 项目创建时间 update_time String 项目更新时间 delete_time String 请求删除时间 is_core Boolean 是否为核心项目 storage_quota Long 项目数据容量配额,-1表示无容量限制 表4 ProjectRoleRsp 参数 参数类型 描述 role_type String 项目角色名 users Array of BindUserRsp objects 项目成员列表 表5 BindUserRsp 参数 参数类型 描述 id String 项目成员用户id name String 项目成员用户名
  • 响应示例 状态码: 200 OK { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda", "name" : "demo-project", "obs_bucket_name" : "eihealth-demo-project-sjdj3", "swr_namespace" : "eihealth-demo-project-sjdj3", "tags" : [ "tag1" ], "description" : "This is demo project", "creator" : "demo-user", "role" : "Admin", "roles" : [ { "role_type" : "Admin", "users" : [ { "id" : "adb1376b-72f9-4d15-9f95-9b533cb96dce", "name" : "demo-user" } ] } ], "size" : 1123243535, "status" : "TO_BE_DELETED", "update_time" : "2020-09-10T10:07:17Z", "create_time" : "2020-09-10T10:07:17Z", "delete_time" : "2020-09-10T10:07:17Z" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 expires_time String 过期时间 project ProjectDto object 项目 roles Array of RoleDto objects 角色 user UserDto object 用户 表4 ProjectDto 参数 参数类型 描述 id String 项目id name String 项目名 表5 RoleDto 参数 参数类型 描述 id String 角色id name String 角色名 表6 UserDto 参数 参数类型 描述 domain DomainDto object 账号 id String 用户id name String 用户名 表7 DomainDto 参数 参数类型 描述 id String 账号id name String 账号名
  • 响应示例 状态码: 200 OK { "expires_time" : "2022-09-02T10:08:57.686Z", "project" : { "id" : "06f1c15e6f0010672f86c00300...", "name" : "project-example-01" }, "roles" : [ { "id" : "19bb93eec4ca4f08aefdc02da76d8f3c", "name" : "readonly" } ], "user" : { "domain" : { "id" : "d78cbac186b744899480f25bd022f...", "name" : " IAM Domain" }, "id" : "086ba757f90089cf0fe5c000dbe7f...", "name" : "user-example" } }
  • 请求示例 导入用户,用户id为18c10a09-65d5-4fe8-8337-4ce5570b8a4b,角色为ADMIN,作业配额为10,作业超时时长为1天,CPU的核数配额为50,内存的配额为128GB,用户可创建的项目数为2 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/users/batch-import { "iam_user_id" : "18c10a09-65d5-4fe8-8337-4ce5570b8a4b", "role" : "ADMIN", "settings" : { "job_quota" : 10, "job_timeout" : 1, "cpu_quota" : 50, "mem_quota" : 128, "projects_per_user" : 2 } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 iam_user_id 是 String IAM用户id 最小长度:1 最大长度:128 role 是 String 角色类型:管理员(ADMIN)、操作者(OPERATOR) 最小长度:1 最大长度:64 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
共100000条