GetDatabases - 获取Database信息

更新时间: 2025-02-24 18:07:29

获取指定Catalog下DataBase的信息或列出所有DataBase的信息。

调试

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

授权信息

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

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

请求语法

GET /api/v2/namespaces/{namespace}/catalogs/{catalogName}/databases HTTP/1.1

请求参数

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

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace
catalogNamestring

catalog 名称。

paimon
databaseNamestring

database 名称,为空时返回所有 database 信息。

paimon-ods

返回参数

名称类型描述示例值
object

响应数据。

requestIdstring

请求 ID。

CBC799F0-AS7S-1D30-8A4F-882ED4DD****
successboolean

表示业务请求是否成功。

true
httpCodeinteger

业务状态码,统一为 200;使用 success 表示业务请求是否成功。

200
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

""
errorMessagestring
  • 当 success 为 false,返回业务错误信息;

  • 当 success 为 true,返回空值。

""
dataarray

当 success 为 true,返回满足条件的 database 列表;当 success 为 false,该值为空。

databaseDatabase

Database 信息详情。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": [
    {
      "name": "database-test",
      "properties": {
        "test": "test",
        "test2": 1
      },
      "comment": "测试数据库。"
    }
  ]
}

错误码

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

上一篇: 元数据 下一篇: GetTables - 获取表信息
阿里云首页 实时计算 Flink版 相关技术圈