华为云用户手册

  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体 平台项目ID,您可以在 EIHealth 平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 应用名称 最小长度:1 最大长度:56 version 否 String 应用版本 最小长度:1 最大长度:32
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 apps Array of AppListDto objects 应用列表 count Integer 应用总条数 表5 AppListDto 参数 参数类型 描述 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 icon String 图标base64编码,设置图标后显示,未设置则不显示
  • 响应示例 状态码: 200 OK { "apps" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-app", "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}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 source_project_id 是 String 源项目id 最小长度:1 最大长度:128 import_apps 是 Array of AppSrcReq objects 源应用列表 表4 AppSrcReq 参数 是否必选 参数类型 描述 destination_app_name 是 String 目标应用名称 取值范围:长度为[1,56],以大小写字母开头,允许出现中划线(-)、下划线(_)、小写字母和数字,且必须以大小写字母或数字结尾。 最小长度:1 最大长度:56 destination_app_version 是 String 目标应用版本 取值范围:长度[1,24],以小写字母或数字或大写字母开头,允许出现中划线,必须以小写字母或数字或大写字母结尾。 最小长度:1 最大长度:24 source_app_id 是 String 源应用id 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportAppRsp objects OK 表6 ImportAppRsp 参数 参数类型 描述 source_app_id String 源应用id destination_app_id String 目标应用id destination_app_name String 目标应用名称 version String 应用版本 message String 导入结果信息,仅在导入失败时会返回 status String 导入结果状态 状态码: 207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportAppRsp objects MULTI_STATUS 表8 ImportAppRsp 参数 参数类型 描述 source_app_id String 源应用id destination_app_id String 目标应用id destination_app_name String 目标应用名称 version String 应用版本 message String 导入结果信息,仅在导入失败时会返回 status String 导入结果状态
  • 响应示例 状态码: 200 OK { "source_app_id": "328e5b04-f5f4-6528-3af1-a10790835f73", "destination_app_id": "7513f7c2-eed5-4ebb-bd7d-cee85a87a338", "destination_app_name": "dest_app_name", "version": "1.0.0", "status": "IMPORT_SUC CES S"} 状态码: 207 MULTI_STATUS { "source_app_id": "328e5b04-f5f4-6528-3af1-a10790835f73", "destination_app_id": "7513f7c2-eed5-4ebb-bd7d-cee85a87a338", "destination_app_name": "dest_app_name", "version": "1.0.0", "status": "IMPORT_SUCCESS"}
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/batch-import 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求示例 导入应用,导入后应用名称为dest-demo-app,版本为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/batch-import{ "source_project_id" : "3ce0f1b0-ac10-46a5-8fa7-b16831d7d480", "import_apps" : [ { "destination_app_name" : "dest-demo-app", "destination_app_version" : "1.0.0", "source_app_id" : "2b4b1836-5967-11eb-8a0d-fa163e3ddba1" } ]}
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/subscribe 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 asset_id 是 String 资产id。长度1-128,只能包含字母、数字、下划线和中划线 最小长度:1 最大长度:128 asset_version 是 String 资产版本。长度1-128,字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线 最小长度:1 最大长度:128 destination_app_name 是 String 目标应用名称。取值范围:长度为[1,56],以大小写字母开头,允许出现中划线(-)、下划线(_)、小写字母和数字,且必须以大小写字母或数字结尾。 最小长度:1 最大长度:56 destination_app_version 是 String 目标应用版本。取值范围:长度[1,24],以小写字母或数字或大写字母开头,允许出现中划线,必须以小写字母或数字或大写字母结尾。 最小长度:1 最大长度:24
  • 请求示例 订阅应用,订阅后应用名称为dest_app_name,应用版本为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/subscribe{ "asset_id" : "7513f7c2-eed5-4ebb-bd7d-cee85a87a338", "asset_version" : "1.0.0", "destination_app_name" : "dest_app_name", "destination_app_version" : "1.0.0"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 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 是否是预置模板 表4 DatabaseColumnDto 参数 参数类型 描述 name String 列名 最小长度:1 最大长度:55 type String 列类型 枚举值: Long String Double description String 列描述信息 最大长度:1024 nullable Boolean 列是否允许为空 primary Boolean 是否作为主键 searchable Boolean 是否可查询 unique Boolean 是否唯一 tips String 查询参数格式的提示信息 最大长度:1024
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 template_id 是 String 模板id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "id" : "61e36d9b-b679-....", "name" : "demo-template", "description" : "description", "source_project_name" : "source project", "source_project_id" : "61e36d9b-b679-....", "source_template_id" : "61e36d9b-b679-....", "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}
  • 响应示例 状态码: 200 OK { "count" : 1, "templates" : [ { "id" : "61e36d9b-b679-....", "name" : "demo-template", "description" : "description", "source_project_name" : "source project", "source_project_id" : "61e36d9b-b679-....", "source_template_id" : "61e36d9b-b679-....", "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 } ]}
  • 响应参数 状态码: 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 列描述信息 最大长度:1024 nullable Boolean 列是否允许为空 primary Boolean 是否作为主键 searchable Boolean 是否可查询 unique Boolean 是否唯一 tips String 查询参数格式的提示信息 最大长度:1024
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates/batch-import 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 source_project_id 是 String 源项目id 最小长度:1 最大长度:128 import_templates 是 Array of TemplateSrcReq objects 导入模板列表 表4 TemplateSrcReq 参数 是否必选 参数类型 描述 source_template_id 是 String 源模板id 最小长度:1 最大长度:128 destination_template_name 是 String 导入模板名称 最小长度:3 最大长度:32
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportTemplateResultRsp objects OK 表6 ImportTemplateResultRsp 参数 参数类型 描述 source_project_id String 源项目id source_template_id String 源模板id destination_template_id String 导入后的模板id destination_template_name String 导入后的模板名称 failed_reason String 失败原因,导入失败会返回 status String 导入结果 状态码: 207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportTemplateResultRsp objects MULTI_STATUS 表8 ImportTemplateResultRsp 参数 参数类型 描述 source_project_id String 源项目id source_template_id String 源模板id destination_template_id String 导入后的模板id destination_template_name String 导入后的模板名称 failed_reason String 失败原因,导入失败会返回 status String 导入结果
  • 响应示例 状态码: 200 OK [ { "source_project_id" : "b8899a21-ce85-4434-8....", "source_template_id" : "b8899a21-ce85-4434-8....", "destination_template_id" : "b8899a21-ce85-4434-8....", "destination_template_name" : "imported-template", "failed_reason" : "null", "status" : "success"} ] 状态码: 207 MULTI_STATUS [ { "source_project_id" : "b8899a21-ce85-4434-8....", "source_template_id" : "b8899a21-ce85-4434-8....", "destination_template_id" : "b8899a21-ce85-4434-8....", "destination_template_name" : "imported-template", "failed_reason" : "failed reason", "status" : "fail"} ]
  • 请求示例 导入模板,从ID为b8899a21-ce85-44......的项目导入名为import-template的模板 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates/batch-import{ "source_project_id" : "fce1376b-72f9-4d15....", "import_templates" : [ { "source_template_id" : "b8899a21-ce85-44......", "destination_template_name" : "import-template" } ]}
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求示例 创建模板,模板名为demo-template,有一列名为colum1,类型为Long,值不可为null,且为主键,可搜索 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates{ "name" : "demo-template", "description" : "description", "columns" : [ { "name" : "column1", "type" : "Long", "description" : "description", "nullable" : false, "primary" : true, "searchable" : true, "unique" : true, "tips" : "tips" } ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 模板名称 最小长度:3 最大长度:32 description 否 String 模板描述 最大长度:1024 columns 是 Array of DatabaseColumnDto objects 数据库列信息 表4 DatabaseColumnDto 参数 是否必选 参数类型 描述 name 是 String 列名 最小长度:1 最大长度:55 type 是 String 列类型 枚举值: Long String Double description 否 String 列描述信息 最大长度:1024 nullable 是 Boolean 列是否允许为空 primary 是 Boolean 是否作为主键 searchable 是 Boolean 是否可查询 unique 是 Boolean 是否唯一 tips 否 String 查询参数格式的提示信息 最大长度:1024
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 template_id 是 String 模板id 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates/upload 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 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 FormData参数 参数 是否必选 参数类型 描述 file 是 File 模板文件
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 files 是 Array of strings 导入文件l路径列表 delimiter 是 String 分隔符,常见分隔符为, ; 最小长度:1 最大长度:32 skip_lines 是 Integer 跳过的header行数 最小值:0 最大值:1000
  • 请求示例 导入数据,数据来源为test-project-01项目中的db_test1.txt文件,分隔符为string,跳过的行数为0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases/{database_id}/data{ "files" : [ "test-project-01:/db_test1.txt" ], "delimiter" : "string", "skip_lines" : 0}
共100000条