# 获取收藏夹列表 - ListFavorite #### 功能介绍 获取收藏夹列表。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0100.html)。 #### URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/favorites 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，您可以从[获取项目ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0033.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持字母、数字、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 最小长度：**1** 最大长度：**128** | | eihealth_project_id | 是 | String | **参数解释**： 空间ID，您可以从[获取空间ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0099.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持字母、数字、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 最小长度：**1** 最大长度：**128** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | resource_id | 否 | String | **参数解释**： 资源ID。 **约束限制**： 不涉及 **取值范围**： 长度范围为1到128个字符，仅支持字母、数字、下划线和中划线。 **默认取值**： 不涉及 最小长度：**1** 最大长度：**128** | | offset | 否 | Integer | **参数解释**： 偏移量，查询起始偏移。 **约束限制**： 不涉及 **取值范围**： \[0,100000000\] **默认取值**： 0 最小值：**0** 最大值：**100000000** 缺省值：**0** | | limit | 否 | Integer | **参数解释**： 限制量，单次查询总量。 **约束限制**： 不涉及 **取值范围**： \[1,1000\] **默认取值**： 100 最小值：**1** 最大值：**1000** 缺省值：**100** | | user_name_list | 否 | Array of strings | **参数解释**： 收藏人名称列表。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 最小长度：**1** 最大长度：**128** 数组长度：**0 - 10** | | resource_type_list | 否 | Array of strings | **参数解释**： 资源类型列表。 **约束限制**： 不涉及 **取值范围**： - DOCKING：分子对接 - OPTIMIZATION：分子优化 - ADMET：分子属性预测 - POC_MOL_DESIGN：靶点口袋分子设计 - SEARCH：分子搜索 - GENERATION：分子生成 - CPI：CPI作业 - FEP：自由微扰能 - POCKET_DETECTION：靶点口袋发现 - TARGET_OPT：靶点优化 - CLUSTERING：聚类分析 **默认取值**： 不涉及 最小长度：**1** 最大长度：**128** 数组长度：**0 - 10** | | type_list | 否 | Array of strings | **参数解释**： 收藏类型列表。 **约束限制**： 最多设置5个值。 **取值范围**： - MICROMOLECULE：小分子 - PROTEIN：蛋白质 **默认取值**： 不涉及 最小长度：**1** 最大长度：**16** 数组长度：**0 - 5** | | start_time | 否 | Long | **参数解释**： 查询收藏信息的起始时间，UNIX时间戳，单位毫秒，不填时默认为当前时间。 **约束限制**： 不涉及 **取值范围**： 时间戳，范围为1000000000000到9999999999999。 **默认取值**： 不涉及 最小值：**1000000000000** 最大值：**9999999999999** | | end_time | 否 | Long | **参数解释**： 查询收藏信息的结束时间，UNIX时间戳，单位毫秒，不填时默认为当前时间。 **约束限制**： 不涉及 **取值范围**： 时间戳，范围为1000000000000到9999999999999。 **默认取值**： 不涉及 最小值：**1000000000000** 最大值：**9999999999999** | | key_word | 否 | String | **参数解释**： 关键字，支持在display_info字段中内容的模糊搜索。 **约束限制**： 不涉及 **取值范围**： 长度为\[0-128\]个字符 **默认取值**： 不涉及 最小长度：**0** 最大长度：**128** | | sort_dir | 否 | String | **参数解释**： 排序规则，目前默认时间降序。 **约束限制**： 不涉及 **取值范围**： - ASC：按升序排列 - DESC：按降序排列 **默认取值**： DESC 缺省值：**DESC** | | sort_key | 否 | String | **参数解释**： 排序规则，目前默认按收藏时间create_time降序。 **约束限制**： 不涉及 **取值范围**： - create_time：收藏时间 - user_name：用户名 - resource_name：资源名称 - resource_type：资源类型 **默认取值**： 按收藏时间create_time降序。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，[获取Token](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0011.html)接口响应消息头中X-Subject-Token的值即为Token。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-32768\]个字符。 **默认取值**： 不涉及 最小长度：**1** 最大长度：**32768** | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | favorites | Array of [FavoriteDto] objects | **参数解释**： 收藏列表。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | count | Integer | **参数解释**： 收藏总数。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表5FavoriteDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 收藏ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | type | String | **参数解释**： 收藏类型。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 最小长度：**1** 最大长度：**16** | | user_id | String | **参数解释**： 收藏者的用户ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | user_name | String | **参数解释**： 收藏者的用户名称。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | create_time | String | **参数解释**： 收藏时间。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | resource_id | String | **参数解释**： 资源ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | resource_name | String | **参数解释**： 资源名称。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | resource_type | String | **参数解释**： 资源类型。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | display_info | String | **参数解释**： 展示信息。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 最小长度：**1** 最大长度：**1000000** | | location_info | String | **参数解释**： 定位信息。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 最小长度：**1** 最大长度：**1000000** | #### 请求示例 获取收藏列表。 ``` https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/favorites ``` #### 响应示例 **状态码：200** OK ``` { "favorites" : [ { "id" : "7ee3a638-aaba-469c-b3b6-a0680536517a", "type" : "MOLECULE", "user_id" : "c41e4714-1ca3-4613-90ae-f7d0cc7186dd", "user_name" : "gwj-test-01", "create_time" : "2021-01-30T02:34:36Z", "resource_type" : "OPTIMIZATION", "resource_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "resource_name" : "demo-resource", "display_info" : "{\"smiles\":\"c1ccccc1\",\"molecule_name\":\"AA-173/40757587\"}", "location_info" : "{\"receptor_idx\":\"1\",\"result_idx\":\"1\"}" } ], "count" : 12 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ai4sservice/ErrorCode.html)。