华为云用户手册

  • 请求示例 批量重试作业,重试如下两个作业 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-retry { "ids" : [ "baabcb56-5bb6-11eb-8a0d-......1", "baabcb56-5bb6-11eb-8a0d-......2" ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchOperateJobRsp objects OK 表5 BatchOperateJobRs 参数 参数类型 描述 id String 作业id。 status String 批量操作作业的结果。 枚举值: SUCCEEDED FAILED message String 操作结果失败信息,仅在操作失败时会返回。 状态码: 207 表6 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchOperateJobRsp objects MULTI_STATUS 表7 BatchOperateJobRsp 参数 参数类型 描述 id String 作业id。 status String 批量操作作业的结果。 枚举值: SUCCEEDED FAILED message String 操作结果失败信息,仅在操作失败时会返回。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 批量操作作业id列表。 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-retry 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体 平台项目ID,您可以在 EIHealth 平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-terminate 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchOperateJobRsp objects OK 表5 BatchOperateJobRsp 参数 参数类型 描述 id String 作业id。 status String 批量操作作业的结果。 枚举值: SUCCEEDED FAILED message String 操作结果失败信息,仅在操作失败时会返回。 状态码: 207 表6 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchOperateJobRsp objects MULTI_STATUS 表7 BatchOperateJobRsp 参数 参数类型 描述 id String 作业id。 status String 批量操作作业的结果。 枚举值: SUCCEEDED FAILED message String 操作结果失败信息,仅在操作失败时会返回。
  • 响应示例 状态码: 200 OK [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "status" : "SUCCEEDED", "message" : "string" } ] 状态码: 207 MULTI_STATUS [ { "id" : "baabcb56-5bb6-11eb-8a0d-......1", "status" : "SUCCEEDED", "message" : "string" }, { "id" : "baabcb56-5bb6-11eb-8a0d-......2", "status" : "FAILED", "message" : "string" } ]
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 X-Force 否 Boolean 是否强制停止作业。 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 批量操作作业id列表。 最小长度:1 最大长度:128
  • 请求示例 批量取消作业,取消如下两个作业,默认强制终止模式 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-terminate { "ids" : [ "baabcb56-5bb6-11eb-8a0d-......1", "baabcb56-5bb6-11eb-8a0d-......2" ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 资产名称。 最小长度:1 最大长度:56 version 是 String 资产版本。 最小长度:1 最大长度:24 picture 否 String 封面图片base64编码。 最小长度:0 最大长度:50000 title 否 String 展示名。 最小长度:0 最大长度:128 summary 否 String 短描述。 最小长度:0 最大长度:128 description 否 String 长描述。 最小长度:0 最大长度:65535 labels 否 Array of strings 标签列表。 最小长度:1 最大长度:32
  • 请求示例 发布流程,流程的名称为demo-workflow,版本为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/workflows/publish { "name" : "demo-workflow", "version" : "1.0.0", "picture" : "", "title": "title", "labels" : [ "label1", "label2" ], "summary" : "summary", "description" : "description" }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/workflows/{workflow_id}/publish 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 workflow_id 是 String 流程id。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表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
  • 请求示例 发布应用资产,资产名称为demo-app,版本为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/publish { "name" : "demo-app", "version" : "1.0.0", "title": "title", "picture" : "", "labels" : [ "label1", "label2" ], "summary" : "summary", "description" : "description" }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/{app_id}/publish 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 app_id 是 String 应用id。 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 异步任务的状态:等待中、运行中、已完成、失败 枚举值: waiting running finished failed task_data SearchTaskData object 分子搜索任务的请求体 result SearchResult object 分子搜索任务的返回结果 表4 SearchTaskData 参数 参数类型 描述 smiles String 分子SMILES表达式 databases Array of strings 搜索使用到的数据库集合 top_n Integer 期望最大返回条目数(排序后取Top) 最小值:1 最大值:1000 表5 SearchResult 参数 参数类型 描述 smiles String 分子SMILES表达式 databases Array of strings 搜索使用到的数据库集合 top_n Integer 期望返回的条目数 prop_names Array of strings 分子ADMET属性名列表 query query object 初始查询分子的属性信息 result Array of SearchResultItem objects 查询结果列表 表6 query 参数 参数类型 描述 smiles String 分子SMILES表达式 props Array of objects 分子ADMET属性值列表 表7 SearchResultItem 参数 参数类型 描述 smiles String 分子SMILES表达式 source String 分子所属的数据库来源 score Float 分子与查询分子的相似度 props Array of objects 分子ADMET属性值列表
  • 响应示例 状态码: 200 分子搜索任务查询成功响应 { "status" : "finished", "result" : { "smiles" : "c1ccccc1", "databases" : [ "drug_space_x", "drug_bank" ], "top_n" : 100, "prop_names" : [ "formula", "ab", "acute_toxicity_rule", "bace" ], "query" : { "smiles" : "c1ccccc1", "props" : [ "C6H6", "base", 0, 0.128335 ] }, "result" : [ { "smiles" : "c1ccccc1", "source" : "drug_bank", "score" : 0.388029, "props" : [ "C6H6", "base", 0, 0.128335 ] }, { "smiles" : "C1CCCCC1", "source" : "drug_bank:drug_space_x", "score" : 0.388029, "props" : [ "C6H12", "base", 0, 0.163034 ] } ] } }
  • 请求示例 发布数据资产,数据资产名称为eihealth-asset,版本为1。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/publish { "name" : "eihealth-asset", "version" : "1", "title" : "title", "summary" : "this is summary", "description" : "this is description", "picture" : "data:image/png;base64,xxxxx", "labels" : [ "label1" ], "paths" : [ "test:/rootFolder/aaa.txt" ] }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/publish 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 资产名。 最小长度:1 最大长度:128 version 是 String 版本号。 最小长度:1 最大长度:64 title 否 String 展示名。 最小长度:0 最大长度:128 summary 否 String 短描述。 最小长度:0 最大长度:128 description 否 String 详细描述。 最小长度:0 最大长度:65535 picture 否 String 封面图片base64编码。 最小长度:0 最大长度:50000 labels 否 Array of strings 标签列表。 最小长度:1 最大长度:32 paths 是 Array of strings 路径列表。 最小长度:1 最大长度:2000
  • URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/{path}/policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 path 是 String 对象全路径。格式为:项目名称:|路径。 最小长度:1 最大长度:2000
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 delete_policy 是 String 删除策略。取值包括allow和deny。 枚举值: allow:允许 deny:禁止
  • 响应示例 状态码: 201 CREATED { "id": "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "app_infos": [ { "app_id": "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "app_name": "demo-app", "app_version": "1.0.0", "app_node_labels": [ "health.node" ] } ], "job_info": { "job_name": "demo-job", "job_node_labels": [ "health.node" ] }}
  • 响应示例 状态码: 200 OK { "id": "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "app_infos": [ { "app_id": "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "app_name": "demo-app", "app_version": "1.0.0", "app_node_labels": [ "health.node" ] } ], "job_info": { "job_name": "demo-job", "job_node_labels": [ "health.node" ] }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户 token 表3 请求Body参数 参数 是否必选 参数类型 描述 smiles 是 String 分子SMILES表达式 databases 是 Array of strings 搜索使用到的数据库集合 top_n 否 Integer 期望最大返回条目数(排序后取Top) 最小值:1 最大值:1000
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs/{auto_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 auto_job_id 是 String 自动作业id。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs/{auto_job_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 auto_job_id 是 String 自动作业id。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 响应示例 状态码: 200 OK { "auto_jobs" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-......", "name" : "demo-job", "description" : "description", "labels" : [ "labelA", "labelB" ], "priority" : 0, "timeout" : 1440, "status" : "SUCCEEDED", "create_time" : "2021-01-30T02:53:26Z", "finish_time" : "2021-01-30T02:53:26Z", "failed_reason" : "Database does not exist.", "user_name" : "test-01", "tool_info" : { "tool_id" : "baabcb56-5bb6-11eb-8a0d-......", "tool_name" : "demo-workflow", "tool_version" : "1.0.0", "tool_type" : "workflow" }, "database_id" : "baabcb56-5bb6-11eb-8a0d-......", "database_name" : "demo-database" } ], "count" : 1}
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Language 否 String Local语言类型,zh_cn返回中文,en_us返回英文 缺省值:en_us 最小长度:1 最大长度:10 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 限制量,单次查询总量,必须由数字组成,默认为100,取值范围[1,1000] 最小值:1 最大值:1000 缺省值:100 offset 否 Integer 偏移量,查询起始偏移,必须由数字组成,默认为0,取值范围[0,100000000] 最小值:0 最大值:100000000 缺省值:0 sort_key 否 String 排序字段,支持字段为:create_time,database_name,name,status,tool_name,user_name。 sort_dir 否 String 排序方向,升序或降序,即ASC 和DESC 缺省值:DESC
共100000条