GetCatalogs - 获取Catalog信息

更新时间: 2024-09-14 17:29:17

获取指定或全部catalog详情。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v2/namespaces/{namespace}/catalogs

请求参数

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

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace
catalogNamestring

catalog 名称,为空时,列表所有 catalog。

paimon

返回参数

名称类型描述示例值
object

响应数据。

requestIdstring

请求 ID。

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

表示业务请求是否成功。

True
httpCodeinteger

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

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

  • 当 success 为 true,返回空值。

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

  • 当 success 为 true,返回空值。

""
dataarray

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

Catalog

catalog 信息详情。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-ABCD-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": [
    {
      "name": "paimon-test",
      "properties": {
        "test": "test",
        "test2": 1
      }
    }
  ]
}

错误码

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

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