ListDatabases - 获取数据库列表

获取数据湖中数据库列表,分页查询,可以根据数据库名称匹配。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dlf:ListDatabaseslist
  • 全部资源
    *

请求语法

GET /api/metastore/catalogs/databases/list HTTP/1.1

请求参数

名称类型必填描述示例值
CatalogIdstring

数据库分类命名空间,默认填写主账号 Uid

1344371
NamePatternstring

数据库名称匹配的正则表达式,全部匹配则传入.*

.*
NextPageTokenstring

翻页 token,由结果返回,如第一页可传入""

2cb472ec1bf84f8d92f9c4baa0d21c19aa!
PageSizeinteger

每页大小

10
  • NamePattern,待查询的 db 名称,支持**.***匹配,.表示匹配一个字符,*表示匹配 n 个字符
  • NextPageToken:分页的开始位置,第一次填写空字符串,后续的填写上一次的 response 中返回的 NextPageToken,如果返回的 NextPageToken 为空字符串,那么说明无数据了。
  • pagesize:一次返回的个数。

返回参数

名称类型描述示例值
object

返回体

Codestring

状态描述

OK
Databasesarray

元数据库列表

DatabaseDatabase

元数据库查询结果

Messagestring

提示相关错误信息

.
NextPageTokenstring

翻页 token

2cb472ec1bf84f8d92f9c4baa0d21c19aa
RequestIdstring

请求 ID

558D764F-8C55-49CA-BF38-80EA532FC08F
Successboolean

是否成功

true

Code 错误码说明
InternalError:其他类型错误,请参考 Message 提示

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Databases": [
    {
      "CreateTime": 1608707407,
      "Description": "this is a hive database",
      "LocationUri": "/hdfs/hivedb/data",
      "Name": "database_test",
      "OwnerName": "zhangsan",
      "OwnerType": "USER",
      "Parameters": {
        "key": "key"
      },
      "Privileges": {
        "GroupPrivileges": {
          "key": [
            {
              "CreateTime": 1606226844,
              "GrantOption": true,
              "Grantor": "Grantor",
              "GrantorType": "GrantorType",
              "Privilege": "Privilege"
            }
          ]
        },
        "RolePrivileges": {
          "key": [
            {
              "CreateTime": 1606226844,
              "GrantOption": true,
              "Grantor": "Grantor",
              "GrantorType": "GrantorType",
              "Privilege": "Privilege"
            }
          ]
        },
        "UserPrivileges": {
          "key": [
            {
              "CreateTime": 1606226844,
              "GrantOption": true,
              "Grantor": "Grantor",
              "GrantorType": "GrantorType",
              "Privilege": "Privilege"
            }
          ]
        }
      },
      "UpdateTime": 1608707407,
      "CreatedBy": "root"
    }
  ],
  "Message": ".",
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "RequestId": "558D764F-8C55-49CA-BF38-80EA532FC08F",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史