文档首页/数据治理中心 DataArts Studio/API参考/管理中心API/数据源元数据获取/获取数据库列表（待下线） - ListDatabases_offline
更新时间：2025-11-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取数据库列表（待下线） - ListDatabases_offline

功能介绍

获取数据库列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/{connection_id}/databases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

connection_id

是

String

数据连接id，可通过数据连接列表中获取。

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

String

数据条数限制。

offset

否

String

偏移量。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

workspace

是

String

数据所在空间的id值。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

当前数据连接数据库记录数。

dw_id

String

数据连接id。

databases

Array of DatabasesList objects

数据库列表。

表5 DatabasesList

参数

参数类型

描述

database_name

String

数据库名称。

description

String

数据库描述。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

返回的错误信息。

error_code

String

返回的错误码。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_msg

String

返回的错误信息。

error_code

String

返回的错误码。

请求示例

无

响应示例

状态码：200

Success，返回数据库列表。

{
  "dw_id" : "f6ce0c0de8f14ba8b7fbf23486b8ec16",
  "databases" : [ {
    "database_name" : "dlcatalog_2fe5",
    "description" : null
  }, {
    "database_name" : "dlcatalog_3e24",
    "description" : null
  }, {
    "database_name" : "dlcatalog_677a",
    "description" : null
  }, {
    "database_name" : "dlcatalog_86e4",
    "description" : null
  }, {
    "database_name" : "dlcatalog_ced5",
    "description" : null
  } ],
  "total_count" : 21
}

状态码：400

BadRequest。

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed， detail msg {0}."
}

状态码：500

Internal Server Error。

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

状态码

状态码

描述

200

Success，返回数据库列表。

400

BadRequest。

500

Internal Server Error。

父主题： 数据源元数据获取

相关文档