# 获取数据库列表 - ListDrugDatabase #### 功能介绍 获取数据库列表。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0100.html)。 #### URI GET /v1/{project_id}/drug/databases 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，您可以从[获取项目ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0033.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持字母、数字、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | search_key | 否 | String | **参数解释**： 数据库名称搜索。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-128\]个字符。 **默认取值**： 不涉及 | | type | 否 | String | **参数解释**： 数据库类型搜索。 **约束限制**： 不涉及 **取值范围**： - custom：自定义数据库 - official：官方数据库 **默认取值**： 不涉及 | | sort_key | 否 | String | **参数解释**： 排序规则，仅支持创建时间、更新时间。 **约束限制**： **取值范围**： - create_time：根据创建时间排序。 - update_time：根据更新时间排序。 **默认取值**： 不涉及 | | sort_dir | 否 | String | **参数解释**： 排序规则。 **约束限制**： 不涉及 **取值范围**： - acs：升序。 - desc：降序。 **默认取值**： desc | | limit | 否 | Integer | **参数解释**： 限制量，单次查询总量。 **约束限制**： 不涉及 **取值范围**： 1-1000 **默认取值**： 100 | | offset | 否 | Integer | **参数解释**： 偏移量，查询起始偏移。 **约束限制**： 不涉及 **取值范围**： 0-100000000 **默认取值**： 0 | #### 请求参数 表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\]个字符。 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | databases | Array of [DrugDatabaseDto] objects | **参数解释**： 数据库列表响应体。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | count | Integer | **参数解释**： 数据库总数。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | cur_user_count | Integer | **参数解释**： 当前用户数据库总数。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表5DrugDatabaseDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 数据库ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | name | String | **参数解释**： 数据库名称。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | type | String | **参数解释**： 数据库类型。 **约束限制**： 不涉及 **取值范围**： - custom：自定义数据库 - official：官方数据库 **默认取值**： 不涉及 | | status | String | **参数解释**： 数据库状态。 **约束限制**： 不涉及 **取值范围**： - WAITING：等待中 - CREATING：创建中 - APPENDING：数据追加中 - FINISHED：已完成 - FAILED：失败 - ABNORMAL：异常 **默认取值**： 不涉及 | | description | String | **参数解释**： 数据库描述。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | create_time | String | **参数解释**： 数据库创建时间。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | update_time | String | **参数解释**： 数据库更新时间。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | creator | String | **参数解释**： 创建数据库的用户名称。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | failed_message | String | **参数解释**： 失败提示。 **约束限制**： 当作业执行失败时会返回。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | css_id | String | **参数解释**： CSS集群ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | css_name | String | **参数解释**： CSS集群名称。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | files | Array of [DetailDatabaseFile] objects | **参数解释**： 数据库文件列表。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | columns | Array of strings | **参数解释**： 数据库列名。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | shareable | Boolean | **参数解释**： 是否打开组织共享。 **约束限制**： 不涉及 **取值范围**： - true：组织共享。 - false：组织不共享。 **默认取值**： 不涉及 | | data_num | Integer | **参数解释**： 分子数量。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表6DetailDatabaseFile | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source | String | **参数解释**： 数据库文件来源。 **约束限制**： 不涉及 **取值范围**： - public：公共数据 - private：私有数据 **默认取值**： 不涉及 | | url | String | **参数解释**： 文件URL。 **约束限制**： 当数据源source为外部网络数据时为https地址，为用户私有数据中心时为空间路径，为公共数据场景时为obs地址。 **取值范围**： 文件URL仅支持以.csv结尾，长度1-2000个字符。 **默认取值**： 不涉及 | | eihealth_project_id | String | **参数解释**： 数据库文件所在空间ID，您可以从[获取空间ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0099.html)中获取。 **约束限制**： 仅文件为数据中心时填写。 **取值范围**： 仅支持字母、数字、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 | | status | String | **参数解释**： 数据库文件写入状态。 **约束限制**： 不涉及 **取值范围**： - WAITING：等待中 - CREATING：创建中 - APPENDING：数据追加中 - FINISHED：已完成 - FAILED：失败 - ABNORMAL：异常 **默认取值**： 不涉及 | | failed_reason | String | **参数解释**： 失败原因。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求示例 获取数据库列表，查询起始偏移为0，单次查询总量为10。 ``` https://{endpoint}/v1/{project_id}/drug/databases?imit=10&offset=0 ``` #### 响应示例 **状态码：200** OK ``` { "count" : 1, "cur_user_count" : 1, "databases" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "database_name", "status" : "ACTIVE", "description" : "数据库ID。", "create_time" : "2024-01-30T02:34:36Z", "update_time" : "2024-01-30T02:53:26Z", "creator" : "demo_user_name", "failed_message" : "null", "files" : [ { "source" : "public", "url" : "project:/test/url.csv", "eihealth_project_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "status" : "SUCCESS" } ], "columns" : [ "SMILES", "NAME" ], "shareable" : true, "data_num" : 500 } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ai4sservice/ErrorCode.html)。