仅用于查询数据湖元数据表的名称列表

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /api/metastore/catalogs/databases/tables/names 

请求参数

名称 类型 位置 是否必选 示例值 描述
CatalogId String Query 1344371

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

TableNamePattern String Query .*

元数据表匹配正则表达式

NextPageToken String Query ''

翻页token,从返回结果返回,无则传空字符串或''

PageSize Integer Query 10

每页大小

DatabaseName String Query database_test

元数据库名称

TableType String Query MANAGED_TABLE

元数据表的类型:例如MANAGED_TABLE,EXTERNAL_TABLE,VIRTUAL_VIEW,INDEX_TABLE,MATERIALIZED_VIEW

RegionId String Host cn-hangzhou

系统所在的地域ID

返回数据

名称 类型 示例值 描述
Code String OK

状态码描述

Message String .

提示相关错误信息

NextPageToken String 2cb472ec1bf84f8d92f9c4baa0d21c19aa

翻页token

RequestId String B7F4B621-E41E-4C84-B97F-42B5380A32BB

请求ID

Success Boolean true

是否成功

TableNames Array of String table1

元数据表的名称

Code错误码说明

InternalError:其他类型错误,请参考Message提示

示例

请求示例

GET /api/metastore/catalogs/databases/tables/names HTTP/1.1 
 {
	"TableType":"MANAGED_TABLE",
	"PageSize":"10",
	"TableNamePattern":".*",
	"NextPageToken":"''",
	"DatabaseName":"database_test",
	"RegionId":"cn-hangzhou",
	"CatalogId":"1344371"
}

正常返回示例

JSON 格式

{
  "Success": true,
  "Code": "OK",
  "Message": "",
  "HttpStatusCode": 200,
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "TableNames": [
    "table1",
    "table2",
    "table3"
  ]
}

错误码

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

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