ListDataLakeTableName - 获取数据湖表名列表

调用此API可获取数据湖表名列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:ListDataLakeTableName

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Tid

integer

租户 ID。

说明

取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息

3****

CatalogName

string

数据目录名。

hive

DbName

string

数据库名称。

default

TableNamePattern

string

数据表名称匹配正则表达式。

.*

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

f056501ada12****

MaxResults

integer

分页大小。最大值为 100。

20

TableType

string

数据表的类型,取值如下:

  • MANAGED_TABLE:内部表。

  • EXTERNAL_TABLE:外部表。

  • VIRTUAL_VIEW:虚拟视图。

  • INDEX_TABLE:索引表。

  • MATERIALIZED_VIEW:物化视图。

MANAGED_TABLE

WorkspaceId

integer

工作空间 ID。

12****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。用于定位日志,排查问题。

C5B8E84B-42B6-4374-AD5A-6264E175****

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功。

  • false:请求失败。

true

ErrorCode

string

错误码,请求异常时返回。

UnknownError

ErrorMessage

string

调用失败时,返回的错误信息。

UnknownError

TableNameList

array

表名列表。

string

表名称。

test_name

NextToken

string

令牌(Token)信息。

NesLoKLEdIZrKhDT7I2gS****

MaxResults

integer

分页大小。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "C5B8E84B-42B6-4374-AD5A-6264E175****",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "TableNameList": [
    "test_name"
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****",
  "MaxResults": 20
}

错误码

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

变更历史

更多信息,参考变更详情