# 获取模型列表 #### 功能介绍 获取模型列表。 #### URI GET /v1/{project_id}/drug-models 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，您可以从[获取项目ID](https://support.huaweicloud.com/api-eihealth/eihealth_33_0044.html)中获取。 最小长度：**1** 最大长度：**128** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | search_key | 否 | String | 模糊搜索值。 最小长度：**0** 最大长度：**1024** | | creator_list | 否 | Array | 创建者列表。 最小长度：**1** 最大长度：**128** 数组长度：**0 - 50** | | type_list | 否 | Array | 模型类型列表。 数组长度：**0 - 10** | | status_list | 否 | Array | 模型状态列表。 数组长度：**0 - 10** | | sort_key | 否 | String | 排序规则 目前默认时间降序，支持根据create_time\|finish_time\|base_model_name。 | | sort_dir | 否 | String | 排序规则 目前默认时间降序。 缺省值：**DESC** | | create_start_time | 否 | Long | 最小创建时间。 最小值：**1000000000000** 最大值：**9999999999999** | | create_end_time | 否 | Long | 最大创建时间。 最小值：**1000000000000** 最大值：**9999999999999** | | finish_start_time | 否 | Long | 最小结束时间。 最小值：**1000000000000** 最大值：**9999999999999** | | finish_end_time | 否 | Long | 最大结束时间。 最小值：**1000000000000** 最大值：**9999999999999** | | limit | 否 | Integer | 限制量，单次查询总量，必须由数字组成，默认为100，取值范围\[1,1000\]。 最小值：**1** 最大值：**1000** 缺省值：**100** | | offset | 否 | Integer | 偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围\[0,100000000\]。 最小值：**0** 最大值：**100000000** 缺省值：**0** | | base_model_list | 否 | Array | 基模型id列表。 最小长度：**0** 最大长度：**128** 数组长度：**0 - 10** | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，[获取Token](https://support.huaweicloud.com/api-eihealth/eihealth_33_0010.html)接口响应消息头中X-Subject-Token的值即为Token。 最小长度：**1** 最大长度：**32768** | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | models | Array of [ModelDto] objects | 模型列表。 | | count | Integer | 模型总数。 | 表5ModelDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 模型名称。 | | id | String | 模型ID。 | | type | String | 模型类型。 | | create_time | String | 模型创建时间。 | | finish_time | String | 模型结束时间。 | | creator | String | 创建模型的用户名称。 | | status | String | 作业状态。 | | shareable | Boolean | 是否打开组织共享。 | | data_quantity | Integer | 模型数据量。 | | file | [ModelFile] object | 模型数据来源。 | | value_range | [ValueRange] object | 区间上下限，仅回归型存在。 | | description | String | 模型描述信息。 | | failed_message | String | 失败提示，当作业执行失败时会返回。 | | losses | Array of floats | 模型训练loss信息。 | | metrics | Array of [ModelMetric] objects | 模型评估指标。 | | base_model_id | String | 基模型id。 缺省值：**pangu-drug-model** | | base_model_name | String | 基模型名称。 缺省值：**pangu-drug-model** | 表6ModelFile | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source | String | 模型数据文件来源。 枚举值： - **public** - **private** | | url | String | 文件URL，用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：**1** 最大长度：**2000** | | eihealth_project_id | String | 模型文件所在项目id，仅文件为数据中心时填写。 最小长度：**1** 最大长度：**128** | 表7ValueRange | 参数 | 参数类型 | 描述 | |:---|:---|:---| | lower | Float | 区间下限，仅回归型存在。 | | upper | Float | 区间上限，仅回归型存在。 | 表8ModelMetric | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 评估指标的名称。 最小长度：**1** 最大长度：**32** | | value | Float | 评估指标的评估结果。 | #### 请求示例 ``` https://{endpoint}/v1/{project_id}/drug-models ``` #### 响应示例 **状态码： 200** OK ``` { "count" : 1, "models" : [ { "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "name" : "demo_name", "description" : "description", "status" : "FINISHED", "create_time" : "2021-01-30T02:34:36Z", "finish_time" : "2021-01-30T02:53:26Z", "creator" : "demo-user", "shareable" : true, "data_quantity" : 1000, "type" : "binary", "file" : { "source" : "PRIVATE", "url" : "project:/file/data.csv" }, "losses" : [ 6.2, 1.2, 4.54 ], "metrics" : [ { "name" : "rmse", "value" : 0.3744 }, { "name" : "mae", "value" : 0.2844 }, { "name" : "pcc", "value" : 0.4871 } ], "base_model_id" : "pangu-drug-model", "base_model_name" : "pangu-drug-model" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eihealth/ErrorCode.html)。