ListDataLakeTable - 获取数据湖表列表_数据管理（兼容数据库备份）(DMS)-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
DataRegion	string	是	数据湖所属的地域。	cn-hangzhou
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***
CatalogName	string	是	数据目录名。	hive
DbName	string	是	数据库名称。	default
TableNamePattern	string	否	元数据表名称，正则表达式匹配	.*
TableType	string	否	数据表的类型，取值如下： MANAGED_TABLE：内部表。 EXTERNAL_TABLE：外部表。 VIRTUAL_VIEW：虚拟视图。 INDEX_TABLE：索引表。 MATERIALIZED_VIEW：物化视图。	MANAGED_TABLE
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	f056501ada12c1cc
MaxResults	integer	否	分页大小。最大值为 100。	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，用于定位日志，排查问题。	3D3FB827-E667-50DB-AD59-C83F8237FECB
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
ErrorCode	string	错误码，请求异常时返回。	UnknownError
ErrorMessage	string	调用失败时，返回的错误信息。	UnknownError
TableList	array	表详情列表。
Table	DLTable	表列表。
NextToken	string	令牌（Token）信息。	NesLoKLEdIZrKhDT7I2gS****
MaxResults	integer	分页大小。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "3D3FB827-E667-50DB-AD59-C83F8237FECB",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "TableList": [
    {
      "ViewOriginalText": "\"\"",
      "Owner": "zhangsan",
      "TableType": "EXTERNAL_TABLE",
      "Parameters": {
        "EXTERNAL": "TRUE",
        "delta.minReaderVersion": "1"
      },
      "Description": "test",
      "CreatorId": 0,
      "CreateTime": 1731586286,
      "StorageDescriptor": {
        "OriginalColumns": [
          {
            "Comment": "from deserializer",
            "Type": "string",
            "Name": "col"
          }
        ],
        "SortCols": [
          {
            "Order": 1,
            "Col": "col1"
          }
        ],
        "Parameters": {
          "test": "test",
          "test2": 1
        },
        "SkewedInfo": {
          "SkewedColValues": [
            [
              "\"123\""
            ]
          ],
          "SkewedColValueLocationMaps": {
            "test": "test",
            "test2": 1
          },
          "SkewedColNames": [
            "col1"
          ]
        },
        "InputFormat": "org.apache.hadoop.mapred.SequenceFileInputFormat",
        "OutputFormat": "org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat",
        "Columns": [
          {
            "Comment": "from deserializer",
            "Type": "string",
            "Name": "col"
          }
        ],
        "IsCompressed": false,
        "SerdeInfo": {
          "SerializationLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
          "DeserializerClass": "org.apache.hadoop.hive.serde2.OpenCSVSerde",
          "Parameters": {
            "serialization.format": "1"
          },
          "Description": "\"serialize\"",
          "SerdeType": 0,
          "SerializerClass": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
          "Name": "name"
        },
        "BucketCols": [
          "2010"
        ],
        "NumBuckets": -1,
        "Location": "oss://xxx"
      },
      "LastAccessTime": 1608707407,
      "Retention": 300,
      "Name": "100g_customer",
      "OwnerType": "USER",
      "ViewExpandedText": "\"\"",
      "DbId": 19,
      "DbName": "default",
      "CatalogName": "hive",
      "PartitionKeys": [
        {
          "Comment": "from deserializer",
          "Type": "string",
          "Name": "col"
        }
      ],
      "ModifierId": 1410769,
      "Location": "oss://xxx"
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****",
  "MaxResults": 20
}

错误码

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