ListDatabaseDetails - 获取数据库详细列表

更新时间:
复制为 MD 格式

获取数据湖中数据库列表,分页查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dlf:ListDatabaseDetails

get

*全部资源

*

请求语法

GET /dlf/v1/{catalogId}/database-details HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

catalogId

string

数据目录 ID。

clg-paimon-xxx

请求参数

名称

类型

必填

描述

示例值

maxResults

integer

分页大小 默认值: 1000 最大值: 1000

1000

pageToken

string

翻页令牌,用于获取下一页数据。如果响应结果中没有提供,则传空字符串("")或空字符('')。

""

databaseNamePattern

string

sql 风格数据库右模糊匹配模式,支持%。

database%

返回参数

名称

类型

描述

示例值

object

返回体。

nextPageToken

string

翻页令牌,用于获取下一页数据。当返回 null 时,表示当前查询的是最后一页结果。

E8ABEB1C3DB893D16576269017992F57

databaseDetails

array

数据库列表。

Database

数据库。

示例

正常返回示例

JSON格式

{
  "nextPageToken": "\t\nE8ABEB1C3DB893D16576269017992F57\n",
  "databaseDetails": [
    {
      "id": "1",
      "name": "test_database",
      "location": "oss://clg-paimon-xxx/db-xxx\n",
      "options": {
        "key": "{\\\"comment\\\":\\\"测试\\\"}"
      },
      "owner": "acs:ram::[accountId]:root",
      "createdAt": 1744970111419,
      "createdBy": "acs:ram::[accountId]:root",
      "updatedAt": 1744970111419,
      "updatedBy": "acs:ram::[accountId]:root",
      "tableCount": 0
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情