ListDataLakeTable API用於擷取資料湖表列表-Data Management-阿里雲

調用此API可擷取資料湖表列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListDataLakeTable

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID。說明取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。	3****
CatalogName	string	是	資料目錄名。	hive
DbName	string	是	資料庫名稱。	default
TableNamePattern	string	否	中繼資料表名稱，Regex匹配。	.*
TableType	string	否	資料表的類型，取值如下： MANAGED_TABLE：內部表。 EXTERNAL_TABLE：外部表格。 VIRTUAL_VIEW：虛擬視圖。 INDEX_TABLE：索引表。 MATERIALIZED_VIEW：物化視圖。	MANAGED_TABLE
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	f056501ada12****
MaxResults	integer	否	分頁大小。最大值為 100。	20
WorkspaceId	integer	否	工作空間 ID。	12****

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求的 ID，用於定位日誌，排查問題。	3D3FB827-E667-50DB-AD59-C83F8237****
Success	boolean	是否調用成功。 true：調用成功。 false：調用失敗。	true
ErrorCode	string	錯誤碼，請求異常時返回。	UnknownError
ErrorMessage	string	調用失敗時，返回的錯誤資訊。	UnknownError
TableList	array	表詳情列表。
	DLTable	表列表。
NextToken	string	令牌（Token）資訊。	NesLoKLEdIZrKhDT7I2gS****
MaxResults	integer	分頁大小。	20

樣本

正常返回樣本

JSON格式

{
  "RequestId": "3D3FB827-E667-50DB-AD59-C83F8237****",
  "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
}

錯誤碼

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

變更歷史

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