調用ListTables介面查詢資料地圖的資料表列表-巨量資料開發治理平台 DataWorks-阿里雲

查詢資料地圖中的資料表列表。對於不支援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 介面返回結果，以及中繼資料實體相關概念說明。可為表所屬資料庫，`ParentMetaEntityId`格式為`${EntityType}:${執行個體 ID 或轉義後的 URL}:${資料目錄標識}:${資料庫名稱}`，對於不存在的層級Null 字元佔位。也可為表所屬資料庫模式，`ParentMetaEntityId`格式為`${EntityType}:${執行個體 ID 或轉義後的 URL}:${資料目錄標識}:${資料庫名稱}:${模式名稱}`，對於不存在的層級Null 字元佔位說明只有資料庫類型支援 schema（`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle`，其中 maxcompute 類型需要開啟三層模型)時, `ParentMetaEntityId`才可使用資料庫模式，否則只能使用資料庫。對於 maxcompute 和 dlf 類型，執行個體 ID 使用Null 字元佔位。對於 maxcompute 類型，資料庫名稱即為 maxcompute 專案名稱。 starrocks 類型的資料目錄標識為目錄名稱，dlf 類型的資料目錄標識為目錄 ID, 其他類型不支援目錄層級，可用Null 字元佔位。幾種常用類型 ParentMetaEntityId 格式參考如下 `maxcompute-project:::project_name` `maxcompute-schema:::project_name:schema_name` (僅專案開啟三層模型時) `dlf-database::catalog_id:database_name` `hms-database:instance_id::database_name` `holo-schema:instance_id::database_name:schema_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` 說明其中 `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 建立時間 ModifyTime 修改時間 Name 名稱 TableType 表類型	CreateTime
Order	string	否	排序方向，預設為 Asc，枚舉值，當前支援 Asc 升序 Desc 降序	Asc
PageNumber	integer	否	分頁頁碼，預設為 1。	1
PageSize	integer	否	分頁大小，預設為 10，最大為 100。	10

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	E25887B7-579C-54A5-9C4F-83A****
Success	boolean	請求是否成功。	true
PagingInfo	object	分頁結果。
TotalCount	integer	總條數。	100
PageNumber	integer	分頁頁碼。	1
PageSize	integer	分頁大小。	10
Tables	array	資料表列表。
	Table	資料表詳情。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A****",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Tables": [
      {
        "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl",
        "Name": "test_tbl",
        "Comment": "測試表",
        "TableType": "TABLE",
        "PartitionKeys": [
          "ds"
        ],
        "ParentMetaEntityId": "maxcompute-schema:123456XXX::test_project_with_schema:default\nmaxcompute-project:123456XXX::test_project_without_schema\ndlf-database:123456XXX:test_catalog:test_db\nhms-database:c-abc123xxx::test_db\nholo-schema:h-abc123xxx::test_db:test_schema",
        "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": "{\\\"k1\\\":\\\"v1\\\"}"
          }
        },
        "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
          }
        }
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。