ListDatabases_数据湖构建_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dlf:ListDatabases
List
全部资源
*

请求语法

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

请求参数

字段名称字段详情
CatalogIdstring

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

示例值:1344371参考取值来源:
    GetCatalog
    ListCatalogs
    CreateCatalog
    SearchAcrossCatalog
NamePatternstring

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

示例值:.*
NextPageTokenstring

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

示例值:2cb472ec1bf84f8d92f9c4baa0d21c19aa!
PageSizeinteger<int32>

每页大小

示例值:10取值 <= 1000000

请求说明

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

返回参数

字段名称字段详情
Codestring

状态描述

示例值:OK
Databasesarray<Database>

元数据库列表

示例值:[{"name":"test"}]
Messagestring

提示相关错误信息

示例值:.
NextPageTokenstring

翻页 token

示例值:2cb472ec1bf84f8d92f9c4baa0d21c19aa
RequestIdstring

请求 ID

示例值:558D764F-8C55-49CA-BF38-80EA532FC08F
Successboolean

是否成功

示例值:true

返回说明

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

返回示例

变更历史

暂无变更历史

相关示例