获取数据库列表

功能介绍

获取数据库列表。

URI

GET /v1/{project_id}/drug/databases

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，您可以从获取项目ID中获取。最小长度：1 最大长度：128

表2 Query参数
参数	是否必选	参数类型	描述
search_key	否	String	数据库名称搜索。最小长度：0 最大长度：128
type	否	String	数据库类型搜索。
sort_key	否	String	排序规则目前默认时间降序，支持根据create_time\|update_time。
sort_dir	否	String	排序规则目前默认时间降序。缺省值：desc
limit	否	Integer	限制量，单次查询总量，必须由数字组成，默认为100，取值范围[1,1000]。最小值：1 最大值：1000 缺省值：100
offset	否	Integer	偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围[0,100000000]。最小值：0 最大值：100000000 缺省值：0

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。最小长度：1 最大长度：32768

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
databases	Array of DrugDatabaseDto objects	数据库列表。
count	Integer	数据库总数。
cur_user_count	Integer	当前用户数据库总数。

表5 DrugDatabaseDto
参数	参数类型	描述
id	String	数据库id。
name	String	数据库名称。
type	String	数据库类型。
status	String	数据库状态。
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	是否打开组织共享。
data_num	Integer	分子数量。

表6 DetailDatabaseFile
参数	参数类型	描述
source	String	数据库文件来源。枚举值： public private
url	String	文件URL，用户私有数据中心为项目路径、公共数据场景为obs地址。最小长度：1 最大长度：2000
eihealth_project_id	String	数据库文件所在项目id，仅文件为数据中心时填写。最小长度：1 最大长度：128
status	String	数据库文件写入状态。
failed_reason	String	失败原因

请求示例

无

响应示例

状态码： 200

[ {
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
  "name" : "database_name",
  "status" : "ACTIVE",
  "description" : "description",
  "create_time" : "2024-01-30T02:34:36Z",
  "update_time" : "2024-01-30T02:53:26Z",
  "creator" : "demo_user_name",
  "failed_message" : "null",
  "css_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2",
  "css_name" : "css_name",
  "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
} ]