查询数据地图中的数据表列表。 对于不支持schema级别的类型，支持查询给定数据库下的数据表列表； 对于支持schema级别的类型，支持查询给定数据库/maxcompute项目/模式下的数据表列表。 返回结果中仅包含数据表基础信息，不包含技术元数据与业务元数据信息。
接口说明
- 需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:ListTables | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ParentMetaEntityId | string | 是 | 父层级元数据实体 ID，可参考 ListDatabases/ListSchemas 接口返回结果，以及元数据实体相关概念说明。
说明
maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle，其中 maxcompute 类型需要开启三层模型)时, ParentMetaEntityId才可使用数据库模式，否则只能使用数据库。几种常用类型 ParentMetaEntityId 格式参考如下
说明
其中
instance_id: 实例 ID，对应数据源以实例模式注册时需要提供。encoded_jdbc_url: JDBC 连接串的 URLEncode 编码,对应数据源以连接串方式注册时需要提供。catalog_id: dlf 目录 ID。project_name: maxcompute 项目名称。database_name: 数据库名称。schema_name: schema 名称。 | maxcompute-project:::project_name |
| Name | string | 否 | 名称，模糊匹配。 | abc |
| Comment | string | 否 | 注释，模糊匹配。 | this is a comment |
| TableTypes | array | 否 | 查询的表类型列表，为空时查询所有类型。 | |
| string | 否 | 表类型，取值与数据库类型相关。 | TABLE | |
| SortBy | string | 否 | 排序字段，默认为 CreateTime，枚举值，当前支持
| CreateTime |
| Order | string | 否 | 排序方向，默认为 Asc，枚举值，当前支持
| Asc |
| PageNumber | integer | 否 | 分页页码，默认为 1。 | 1 |
| PageSize | integer | 否 | 分页大小，默认为 10，最大为 100。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "E25887B7-579C-54A5-9C4F-83A****",
"Success": true,
"PagingInfo": {
"TotalCount": 100,
"PageNumber": 1,
"PageSize": 10,
"Tables": [
{
"Id": "dlf-table::catalog_id:database_name::table_name",
"Name": "table_name",
"Comment": "测试表",
"TableType": "TABLE",
"PartitionKeys": [
"ds"
],
"ParentMetaEntityId": "dlf-database::catalog_id:database_name",
"CreateTime": 1736852168000,
"ModifyTime": 1736852168000,
"TechnicalMetadata": {
"Owner": "test_user",
"Location": "oss://test-bucket/test_tbl",
"Compressed": false,
"InputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
"OutputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
"SerializationLibrary": "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
"Parameters": {
"key": "value"
}
},
"BusinessMetadata": {
"Readme": "## 使用说明",
"Tags": [
{
"Key": "tag_key",
"Value": "tag_value"
}
],
"Categories": [
[
{
"Id": "CATEGORY.456",
"Name": "测试类目",
"ParentId": "CATEGORY.123"
}
]
],
"UpstreamTasks": [
{
"Id": 123456,
"Name": "test_task"
}
],
"Extension": {
"ProjectId": 234,
"EnvType": "Dev",
"ViewCount": 0,
"ReadCount": 0,
"FavorCount": 0
}
}
}
]
}
}错误码
访问错误中心查看更多错误码。