华为云用户手册

响应示例 状态码： 200 OK { "name" : "demo-instance", "description" : "description", "template" : { "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 }, "creator" : "demo-user", "create_time" : "2021-01-29T09:10:27Z", "update_time" : "2021-01-29T09:10:27Z", "data_count" : 1000, "source_project_name" : "source-project", "source_project_id" : "61e36d9b-b679-....", "source_id" : "61e36d9b-b679-....", "is_prefab" : false}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 实例id name String 实例名称 description String 描述 template TemplateRsp object 模板详情 creator String 创建者 create_time String 创建时间 update_time String 更新时间 data_count Long 数据条目 source_project_name String 源项目名 source_project_id String 源项目id source_id String 源实例id is_prefab Boolean 是否为预置实例 表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}/databases/{database_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体 平台项目ID，您可以在 EIHealth 平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 database_id 是 String 数据库实例id 最小长度：1 最大长度：128

请求示例 创建数据库实例，名称为demo-instance，模板ID为25ce6fc0-43fe-11eb-8....，导入test-project-01项目中db_test1.txt文件的数据，分隔符为string https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases{ "name" : "demo-instance", "template_id" : "25ce6fc0-43fe-11eb-8....", "description" : "description", "import_data" : { "files" : [ "test-project-01:/db_test1.txt" ], "delimiter" : "string", "skip_lines" : 0 }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限， 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称 最小长度：3 最大长度：32 template_id 是 String 模板id 最小长度：1 最大长度：128 description 否 String 实例描述 最大长度：1024 import_data 否 ImportDataReq object 导入数据请求体 表4 ImportDatabaseDataReq 参数 是否必选 参数类型 描述 files 是 Array of strings 导入文件l路径列表 delimiter 是 String 分隔符，常见分隔符为, ; 最小长度：1 最大长度：32 skip_lines 是 Integer 跳过的header行数 最小值：0 最大值：1000

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。

URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases/{database_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 database_id 是 String 数据库实例id 最小长度：1 最大长度：128

请求参数 表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 source_databases 是 Array of DatabaseSrcReq objects 源数据库列表 表4 DatabaseSrcReq 参数 是否必选 参数类型 描述 source_database_id 是 String 源数据库id 最小长度：1 最大长度：128

响应示例 状态码： 200 OK [ { "source_project_id" : "b8899a21-ce85-4434-8....", "source_database_id" : "b8899a21-ce85-4434-8....;", "destination_database_id" : "aa8899a21-ce85-4434-8....;", "destination_database_name" : "database_name", "failed_reason" : "null", "status" : "success"} ] 状态码： 207 MULTI_STATUS [ { "source_project_id" : "b8899a21-ce85-4434-8....", "source_database_id" : "b8899a21-ce85-4434-8....;", "destination_database_id" : "aa8899a21-ce85-4434-8....;", "destination_database_name" : "database_name", "failed_reason" : "failed reason", "status" : "fail"} ]

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases/batch-quote 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of QuoteDatabaseResultRsp objects OK 表6 QuoteDatabaseResultRsp 参数 参数类型 描述 source_project_id String 源项目id source_database_id String 源数据库id destination_database_id String 引用到项目后的数据库id destination_database_name String 引用到项目后的数据库名称 failed_reason String 失败原因 status String 导入结果 状态码： 207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of QuoteDatabaseResultRsp objects MULTI_STATUS 表8 QuoteDatabaseResultRsp 参数 参数类型 描述 source_project_id String 源项目id source_database_id String 源数据库id destination_database_id String 引用到项目后的数据库id destination_database_name String 引用到项目后的数据库名称 failed_reason String 失败原因 status String 导入结果

请求示例 引用数据库实例，源项目ID为3b8771e4-b3c7-41d5-b....，源数据库实例ID为4b8771e4-b3c7-41d5-b.... { "source_project_id" : "3b8771e4-b3c7-41d5-b....", "source_databases" : [ { "source_database_id" : "4b8771e4-b3c7-41d5-b...." } ]}

响应示例 状态码： 200 OK { "count" : 1, "databases" : [ { "id" : "61e36d9b-b679-4b.....", "name" : "demo-instance", "description" : "description", "template_id" : "61e36d9b-b679-4b.....", "template_name" : "demo-template", "creator" : "demo-user", "create_time" : "2021-01-29T09:10:27Z", "update_time" : "2021-01-29T09:10:27Z", "data_count" : 1000, "source_project_name" : "source-project", "source_project_id" : "61e36d9b-b679-....", "source_id" : "61e36d9b-b679-....", "is_prefab" : false } ]}

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 实例总数 databases Array of DatabaseDto objects 实例详情列表 表4 DatabaseDto 参数 参数类型 描述 id String 实例id name String 实例名称 description String 描述 template_id String 模板id template_name String 模板名称 creator String 实例创建者 create_time String 创建时间 update_time String 更新时间 data_count Long 数据条目 source_project_name String 源项目名 source_project_id String 源项目id source_id String 源实例id is_prefab Boolean 是否为预置实例

URI GET /v1/{project_id}/customer-buckets/{bucket_name}/objects 表1 路径参数 参数 是否必选 参数类型 描述 bucket_name 是 String 桶名称 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 限制量，单次查询总量[1, 1000]，默认100 最小值：1 最大值：1000 缺省值：100 offset 否 Integer 偏移量，查询起始偏移，默认为0 最小值：0 最大值：100000000 缺省值：0 path 否 String 对象全路径（例如：OBS/OBSFS桶名称:/路径/*.*） 最小长度：0 最大长度：2000 search_key 否 String 查询关键词 最小长度：0 最大长度：2000

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 数据（文件夹、文件）总数量 objects Array of BucketObjectDto objects 数据列表 表5 BucketObjectDto 参数 参数类型 描述 path String 对象全路径（OBS/OBSFS桶名称:/路径） name String 名称 type String 类型 枚举值： FILE FOLDER size Long 大小 create_time String 创建时间

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id}/checkpoints 表1 路径参数 参数 是否必选 参数类型 描述 data_job_id 是 String 数据作业id 最小长度：1 最大长度：128 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

URI GET /v1/{project_id}/customer-buckets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 桶类型。OBJECT：桶列表；PFS：并行文件系统。不传返回所有类型。

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id}/retry 表1 路径参数 参数 是否必选 参数类型 描述 data_job_id 是 String 数据作业id 最小长度：1 最大长度：128 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 data_job_id 是 String 数据作业id 最小长度：1 最大长度：128

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 creator 否 String 创建者名称 最小长度：1 最大长度：128 from_time 否 Long 查询该时间之后创建的数据作业（时间戳格式，单位为ms） limit 否 Integer 限制量，单次查询总量，必须由数字组成，默认为100，取值范围[1,1000]。 最小值：1 最大值：1000 缺省值：100 name 否 String 数据作业名称 最小长度：1 最大长度：128 offset 否 Integer 偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围[0,100000000]。 最小值：0 最大值：100000000 缺省值：0 status 否 String 数据作业状态（支持CANCELED,DELETE_CANCELED,DELETE_FAILED,DELETING,FAILED,PENDING,RUNNING,SUCCEED） to_time 否 Long 查询该时间之前创建的数据作业（时间戳格式，单位为ms） type 否 String 数据作业类型 CLONE_DATA DELETE_DATA IMPORT_DATA IMPORT_NETWORK_DATA SUBSCRIBE_DATA ARCHIVE_DATA ARCHIVE_DATA_DELETE RESTORE_DATA DATABASE_IMPORT 最小长度：1 最大长度：64 finish_from_time 否 Long 查询该时间之后完成的数据作业（时间戳格式，单位为ms） finish_to_time 否 Long 查询该时间之前完成的数据作业（时间戳格式，单位为ms） sort_dir 否 String 排序规则 目前默认时间降序 缺省值：desc sort_key 否 String 排序规则 目前默认时间降序，支持根据status,name,type,creator,create_time,end_time

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总条数 data_jobs Array of DataJobRsp objects 数据作业列表 表5 DataJobRsp 参数 参数类型 描述 creator String 数据作业创建者 end_time String 数据作业结束时间 id String 数据作业ID name String 数据作业名称 create_time String 数据作业创建时间 status String 数据作业状态 finish_count Integer 数据作业完成数 total_count Integer 数据作业总数 type String 数据作业类型 failed_reason String 数据作业失败原因 additions String 附加信息

响应示例 状态码： 200 OK { "count": 30, "data_jobs": [ { "creator": "creator", "end_time": "2021-04-21T09:30:37Z", "id": "94116a6b-1945-4581-b64c-2cea712988ab", "name": "DataDelete-20210421093037", "create_time": "2021-04-21T09:30:37Z", "status": "SUCCEED", "finish_count": 4, "total_count": 10, "type": "DELETE_DATA", "failed_reason": "failed reason" } ]}

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id}/cancel 表1 路径参数 参数 是否必选 参数类型 描述 data_job_id 是 String 数据作业id 最小长度：1 最大长度：128 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

响应示例 状态码： 200 OK { "complete_data" : [ "demo" ], "running_data" : [ "demo" ], "creator" : "creator", "source_project_id" : "fce1376b-72f9-4d15-9f95-9b533cb988ab", "source_project_name" : "source-project", "id" : "94116a6b-1945-4581-b64c-2cea712988ab", "name" : "DataDelete-20210421093037", "sources" : [ "demo" ], "create_time" : "2021-04-21T09:30:37Z", "end_time" : "2021-04-21T09:30:37Z", "status" : "SUCCEED", "destinations" : [ "demo" ], "type" : "DELETE_DATA", "failed_reason" : "failed reason"}

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 data_job_id 是 String 数据作业id 最小长度：1 最大长度：128 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 complete_data Array of strings 已完成的数据列表 running_data Array of strings 正在执行的数据列表 creator String 数据作业创建者 source_project_id String 非本项目操作场景下源项目名称 source_project_name String 非本项目操作场景下源项目名称 id String 数据作业ID name String 数据作业名称 sources Array of strings 数据列表 create_time String 数据作业创建时间 end_time String 数据作业结束时间 status String 数据作业状态 destinations Array of strings 数据列表 type String 数据作业类型 failed_reason String 数据作业失败原因 additions String 附加信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 X-Need-Content 否 Boolean 返回文件内容 缺省值：false

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/{path} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID，您可以在EIHealth平台单击所需的项目名称，进入项目设置页面查看“项目编号”。 最小长度：1 最大长度：128 path 是 String 对象全路径（项目名称:|路径） 最小长度：1 最大长度：2000 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128