GetTables - 获取表信息_实时计算 Flink版(Flink)-阿里云帮助中心

获取指定catalog的database下某张表的具体详情或者database下所有表的信息。

调试

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

授权信息

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

请求语法

GET /api/v2/namespaces/{namespace}/catalogs/{catalogName}/databases/{databaseName}/tables

请求参数

名称	类型	必填	描述	示例值
workspace	string	是	工作空间 ID。	a14bd5d90a****
namespace	string	是	项目空间名称。	u-gs3rgla9-default
catalogName	string	是	catalog 名称。	paimon
databaseName	string	是	database 名称。	paimon-ods
tableName	string	否	表名，表名为空返回所有表信息。	item

返回参数

名称	类型	描述	示例值
	object	响应数据。
requestId	string	请求 ID。	ECE641B2-AB0B-4174-9C3B-885881558637
success	boolean	表示业务请求是否成功。	true
httpCode	integer	业务状态码，统一为 200；使用 success 表示业务请求是否成功。	200
errorCode	string	当 success 为 false，返回业务错误码；当 success 为 true，返回空值。	""
errorMessage	string	当 success 为 false，返回业务错误信息；当 success 为 true，返回空值。	""
data	array	当 success 为 true，返回满足条件的表的列表和详情；当 success 为 false，该值为空。
	Table	表信息。

示例

正常返回示例

JSON格式

{
  "requestId": "ECE641B2-AB0B-4174-9C3B-885881558637",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": [
    {
      "name": "order-test",
      "schema": {
        "columns": [
          {
            "name": "name",
            "metadataInfo": {
              "key": "topic",
              "virtual": true
            },
            "expression": "“”",
            "type": "string",
            "nullable": true
          }
        ],
        "watermarkSpecs": [
          {
            "column": "time",
            "watermarkExpression": "INTERVAL '5' SECOND"
          }
        ],
        "primaryKey": {
          "constraintName": "pk",
          "columns": [
            "id"
          ]
        }
      },
      "properties": {
        "test": "test",
        "test2": 1
      },
      "comment": "测试订单表",
      "partitionKeys": [
        "ad=xxxxx"
      ]
    }
  ]
}

错误码

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