ListDataLakeTablebaseInfo - 获取数据湖中表的基本信息

调用此API可以获取数据湖中表的基本信息。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:ListDataLakeTablebaseInfo

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Rows

integer

分页查询时每页的行数。

10

Page

integer

分页查询时列表的页码。

1

SearchKey

string

搜索表名称的关键字。

test

DbName

string

表所在的数据库的名称。

default

CatalogName

string

查询的数据目录名称。

hive

Tid

integer

租户 ID,可通过调用接口 GetUserActiveTenant 获取该参数的值。

3****

WorkspaceId

integer

工作空间 ID。

12****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

B43AD641-49C2-5299-9E06-1B37EC1B****

Success

boolean

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

  • true:请求成功。

  • false:请求失败。

true

ErrorCode

string

错误码

400

ErrorMessage

string

错误信息。

Specified parameter Rows is not valid.

TablebaseInfoList

array

数据湖表列表。

DLTablebaseInfo

表的基本信息。

TotalCount

string

满足条件的表数量。

100

示例

正常返回示例

JSON格式

{
  "RequestId": "B43AD641-49C2-5299-9E06-1B37EC1B****",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "Specified parameter Rows is not valid.",
  "TablebaseInfoList": [
    {
      "Owner": "",
      "ViewOriginalText": "",
      "TableType": "",
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "Description": "",
      "CreatorId": 0,
      "CreateTime": 0,
      "LastAccessTime": 0,
      "Retention": 0,
      "Name": "",
      "OwnerType": "",
      "ViewExpandedText": "",
      "DbId": 0,
      "DbName": "",
      "CatalogName": "",
      "PartitionKeys": [
        {
          "Comment": "",
          "Type": "",
          "Name": ""
        }
      ],
      "ModifierId": 0,
      "Location": ""
    }
  ],
  "TotalCount": "100"
}

错误码

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

变更历史

更多信息,参考变更详情