調用ListDataLakeTablebaseInfo擷取資料湖中的表基本資料列表-Data Management-阿里雲

調用此API可以擷取資料湖中表的基本資料。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListDataLakeTablebaseInfo

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DataRegion	string	是	資料湖所屬的地區。	cn-hangzhou
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": "test",
      "ViewOriginalText": "\"\"",
      "TableType": "EXTERNAL_TABLE",
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "Description": "\"table\"",
      "CreatorId": 0,
      "CreateTime": 1731586286,
      "LastAccessTime": 1608707407,
      "Retention": 30000,
      "Name": "100g_customer",
      "OwnerType": "ROLE ",
      "ViewExpandedText": "\"\"",
      "DbId": 19,
      "DbName": "100g_customer",
      "CatalogName": "hive",
      "PartitionKeys": [
        {
          "Comment": "from deserializer",
          "Type": "string",
          "Name": "col"
        }
      ],
      "ModifierId": 1410769,
      "Location": "oss://xxx"
    }
  ],
  "TotalCount": "100"
}

錯誤碼

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

變更歷史

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