調用GetTableProfile API擷取表資料概況-資料湖構建-阿里雲

介面說明

使用資料概況需要先將該表的 OSS Bucket 進行 Location 託管。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dlf:GetTableProfile

*全部資源

*

無

請求文法

GET /webapi/metastorehouse/catalog/database/tableprofile HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
CatalogId	string	否	資料目錄 ID，預設填寫主帳號 ID	1344371
DatabaseName	string	是	中繼資料庫名稱	test_db
TableName	string	是	中繼資料表名稱	test_tbl

返回參數

名稱	類型	描述	樣本值
	object	Response
Code	string	錯誤碼	-
Message	string	錯誤資訊	-
RequestId	string	請求 ID	97434FA4-A6B2-1AE4-A174-76964F29C759
Success	boolean	請求是否成功。取值如下： true：成功。 false：失敗。	true
TableProfile	TableProfile	表資料概況

樣本

正常返回樣本

JSON格式

{
  "Code": "-",
  "Message": "-",
  "RequestId": "97434FA4-A6B2-1AE4-A174-76964F29C759",
  "Success": true,
  "TableProfile": {
    "PartitionCnt": 3,
    "FileCnt": 5,
    "ObjectCnt": 5,
    "FileSize": 31,
    "ObjectSize": 31,
    "RecordCnt": 2,
    "IsPartitioned": true,
    "LastModifyTime": "2023-08-16 18:02:25",
    "LastAccessTime": "2023-08-22 12:14:42",
    "DatabaseName": "test_db",
    "TableName": "test_tbl",
    "CreateTime": "2023-08-14 10:44:13",
    "Location": "oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/test_tbl/",
    "AccessNum": 0,
    "AccessNumWeekly": 0,
    "AccessNumMonthly": 0,
    "LastAccessNumTime": "",
    "LatestDate": "2023-08-30 19:16:10",
    "LatestAccessNumDate": "",
    "LastDdlTime": "2023-08-16 18:02:24",
    "ObjectAccessNum": 0,
    "ObjectAccessNumWeekly": 18,
    "ObjectAccessNumMonthly": 18,
    "DataSourceType": "OSS_HDFS"
  }
}

錯誤碼

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

變更歷史

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