华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 资产名称 最小长度:1 最大长度:56 version 是 String 资产版本 最小长度:1 最大长度:24 title 否 String 展示名 最小长度:0 最大长度:128 picture 否 String 封面图片base64编码 最小长度:0 最大长度:50000 summary 否 String 短描述 最小长度:0 最大长度:128 description 否 String 长描述 最小长度:0 最大长度:65535 labels 否 Array of strings 标签列表 最小长度:1 最大长度:32 数组长度:0 - 5
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/{app_id}/publish 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 app_id 是 String 应用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" }
  • 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参数 参数 是否必选 参数类型 描述 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 add_hydrogen 否 Boolean 增加氢原子。 缺省值:true
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/statistics 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "workflows" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-workflow", "version" : "1.0.0", "summary" : "summary", "description" : "description", "labels" : [ "labelA", "labelB" ], "create_time" : "2021-01-30T02:34:36Z", "update_time" : "2021-01-30T02:53:26Z", "user_name" : "gwj-test-01" } ], "count" : 1 }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/workflows 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 流程名称 最小长度:1 最大长度:56 version 否 String 流程版本 最小长度:1 最大长度:24
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 workflows Array of WorkflowListDto objects 所查询类型的流程总数 count Integer 当前页的流程列表 表5 WorkflowListDto 参数 参数类型 描述 id String 流程id name String 流程名称 version String 流程版本 summary String 简短描述信息 description String 描述信息 labels Array of strings 流程标签 create_time String 创建流程时间 update_time String 更新流程时间 user_name String 创建用户名称 source_project_name String 源项目名称 source_resource_id String 源资源id
  • 响应示例 状态码: 200 OK { "vendors" : [ { "id" : "09e517572000d42f0ffbc00161366480", "domain_id" : "09e517572000d42f0ffbc00161363380", "name" : "test", "logo" : "data:image/png;base64,iVBOxxxxx" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 供应商个数 vendors Array of VendorDto objects 供应商列表 表4 VendorDto 参数 参数类型 描述 id String 供应商id 最小长度:0 最大长度:128 domain_id String 账号id 最小长度:1 最大长度:32 name String 名称 最小长度:1 最大长度:100 logo String logo图片base64编码 最小长度:0 最大长度:1500000
  • 响应示例 状态码: 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}/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 集群是否可用。
  • 响应示例 状态码: 200 OK { "count" : 1, "templates" : [ { "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "name" : "demo-template", "description" : "description", "source_project_name" : "source project", "source_project_id" : "86e0f1b0-ac10-46a5-8fa7-b26831d7d488", "source_template_id" : "66e0f1b0-ac10-46a5-8fa7-b26831d7d488", "creator" : "demo-user", "columns" : [ { "name" : "column1", "type" : "Long", "description" : "description", "nullable" : false, "primary" : true, "searchable" : true, "unique" : true, "tips" : "tips" } ], "create_time" : "2021-01-29T09:10:27Z", "primary_key" : "ID,GROUP", "is_prefab" : false } ] }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 模板总数 templates Array of TemplateRsp objects 模板列表 表4 TemplateRsp 参数 参数类型 描述 id String 模板id name String 模板名称 description String 模板描述 source_project_name String 来源项目名称 source_project_id String 来源项目id source_template_id String 来源模板id creator String 创建者 columns Array of DatabaseColumnDto objects 数据库列信息列表 create_time String 创建时间 primary_key String 主键 is_prefab Boolean 是否是预置模板 表5 DatabaseColumnDto 参数 参数类型 描述 name String 列名 最小长度:1 最大长度:55 type String 列类型 枚举值: Long String Double description String 列描述信息 最小长度:0 最大长度:1024 nullable Boolean 列是否允许为空 primary Boolean 是否作为主键 searchable Boolean 是否可查询 unique Boolean 是否唯一 tips String 查询参数格式的提示信息 最小长度:0 最大长度:1024
  • 响应示例 状态码: 200 OK { "count" : 1, "jobs" : [ { "id" : "78dfce53-0303-4b46-a2d9-4a067812b289", "workflow_job_id" : "78dfce53-0303-4b46-a2d9-4a067812b289", "name" : "study-job", "status" : "RUNNING", "template_id" : "24dfce53-0303-4b46-a2d9-4a067812b289", "database_name" : "demo-database", "database_id" : "4f7fce53-0303-4b46-a2d9-4a067812b289", "relative_path" : "/docking-summary", "output_file_type" : "csv", "workflow_name" : "docking-summary", "label" : "small-molecular-chemicals", "create_time" : "2021-02-22T07:07:41Z", "update_time" : "2021-02-22T07:07:41Z" } ] }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 study_id 是 String study_id 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 作业总数 jobs Array of StudyJobRsp objects 作业列表 表4 StudyJobRsp 参数 参数类型 描述 id String study作业id workflow_job_id String workflow作业id name String 作业名称 status String 作业状态 template_id String 生成study作业结果的模板id database_name String study作业结果的数据库实例名称 database_id String study作业结果的数据库实例id relative_path String 生成study作业结果的文件的相对路径 output_file_type String 生成study作业结果的文件的类型 workflow_name String 使用的workflow名称 label String 使用的workflow标签 create_time String 作业创建时间 update_time String 作业更新时间
  • 响应示例 状态码: 200 OK { "count" : 1, "studies" : [ { "name" : "demo-study", "id" : "e1ae25a0-070b-41ca-a1a9-3cb8db39e169", "eihealth_project_name" : "e1ae25a0-070b-41ca-a1a9-3cb8db39e169", "eihealth_project_id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda", "description" : "this is a demo study", "create_time" : "2021-02-22T07:06:21Z", "update_time" : "2021-02-22T07:06:21Z", "latest_job" : { "id" : "78dfce53-0303-4b46-a2d9-4a067812b289", "workflow_job_id" : "78dfce53-0303-4b46-a2d9-4a067812b289", "name" : "study-job", "status" : "RUNNING", "template_id" : "24dfce53-0303-4b46-a2d9-4a067812b289", "database_name" : "demo-database", "database_id" : "4f7fce53-0303-4b46-a2d9-4a067812b289", "relative_path" : "/docking-summary", "output_file_type" : "csv", "workflow_name" : "docking-summary", "label" : "small-molecular-chemicals", "create_time" : "2021-02-22T07:07:41Z", "update_time" : "2021-02-22T07:07:41Z" } } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer study总数 studies Array of StudyRsp objects study列表 表4 StudyRsp 参数 参数类型 描述 name String study名称 id String study id eihealth_project_name String 项目名称 eihealth_project_id String 项目id description String study描述 create_time String study创建时间 update_time String study更新时间 latest_job StudyJobRsp object 作业详情返回体 表5 StudyJobRsp 参数 参数类型 描述 id String study作业id workflow_job_id String workflow作业id name String 作业名称 status String 作业状态 template_id String 生成study作业结果的模板id database_name String study作业结果的数据库实例名称 database_id String study作业结果的数据库实例id relative_path String 生成study作业结果的文件的相对路径 output_file_type String 生成study作业结果的文件的类型 workflow_name String 使用的workflow名称 label String 使用的workflow标签 create_time String 作业创建时间 update_time String 作业更新时间
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of StorageResourceRsp objects 存储资源列表 表4 StorageResourceRsp 参数 参数类型 描述 spec SpecDto object 规格信息 size Long 使用量 charge_mode String 计费模式 create_time String 购买时间 status String 状态 表5 SpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64
  • 响应示例 状态码: 200 OK { "count" : 1, "resources" : [ { "spec" : { "code" : "code", "name" : "name" }, "size" : 1024, "charge_mode" : 2, "create_time" : "2021-02-01T14:25:50Z", "status" : "Deploying" } ] }
  • 响应示例 状态码: 200 OK { "count" : 1, "assets" : [ { "id" : "aa78f595-5acb-4be8-b277-229be335626a", "category" : "WORKFLOW", "name" : "Docking Summary", "title" : "Docking Summary", "labels" : [ "molecular docking" ], "picture" : "https://eihealth.obs.cn-north-4.huawei.com:443/assets/metadata/picture.png", "vendor_id" : "00000000000000000000000000000000", "versions" : [ { "version" : "1.0.0", "publisher" : " EIHealth ", "description" : "", "summary" : "summary", "license" : "", "status" : "NORMAL", "labels" : [ "molecular docking", "drug discovery", "smallMolecularChemicals" ], "picture" : "data:image/png;base64,PD94b...", "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z" } ], "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z", "stars" : 1, "subscribes" : 1 } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 资产总数 assets Array of GetAssetRsp objects 资产列表 表4 GetAssetRsp 参数 参数类型 描述 id String 资产id category String 类别 name String 资产名 title String 资产展示名 labels Array of strings 资产标签列表 picture String 资产封面图访问链接 vendor_id String 供应商id versions Array of VersionRsp objects 资产版本号列表 create_time String 创建时间 update_time String 更新时间 stars Integer 收藏数 subscribes Integer 订阅数 表5 VersionRsp 参数 参数类型 描述 version String 资产版本号 publisher String 发布者 description String 资产长描述 summary String 资产短描述 license String 许可证 status String 资产状态 failed_reason String 资产发布失败原因 labels Array of strings 资产标签列表 picture String 资产封面图访问链接 create_time String 创建时间 update_time String 更新时间
  • 响应示例 状态码: 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 执行时间
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 policies Array of ScaleOutPolicyRsp objects 扩容策略列表 表4 ScaleOutPolicyRsp 参数 参数类型 描述 id String 策略ID name String 策略名称 status String 状态 create_time String 创建时间 node_spec NodeSpecDto object 节点规格信息 availability_zone String 可用区 nodes Integer 节点数量 max_nodes Integer 扩容节点数上限 min_nodes Integer 扩容节点数下限 scaling_times Integer 伸缩次数 scaling_enable Boolean 是否开启自动扩容 表5 NodeSpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64 ram Long 内存 vcpus String vcpus
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全