すべてのプロダクト
Search
ドキュメントセンター

Data Management:ListDataLakeTable

最終更新日:Mar 21, 2026

データレイク内のテーブルのリストをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:ListDataLakeTable

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DataRegion

string

必須

データレイクが存在するリージョン。

cn-hangzhou

Tid

integer

任意

テナントの ID。

説明

テナント ID を表示するには、DMS コンソールに移動し、右上のプロフィール画像にポインターを合わせます。 詳細については、「DMS テナントの管理」トピックの「現在のテナントに関する情報の表示」セクションをご参照ください。

3***

CatalogName

string

必須

データカタログの名前。

hive

DbName

string

必須

データベース名。

default

TableNamePattern

string

任意

メタデータテーブルの名前に一致させるために使用される正規表現。

.*

TableType

string

任意

データテーブルのタイプ。 有効な値:

  • MANAGED_TABLE

  • EXTERNAL_TABLE

  • VIRTUAL_VIEW

  • INDEX_TABLE

  • MATERIALIZED_VIEW

MANAGED_TABLE

NextToken

string

任意

次のリクエストで新しい結果ページを取得するために使用されるページネーショントークン。 有効な値:

  • NextToken が空の場合、次のページはありません。

  • NextToken の値が返された場合は、次のクエリに使用されるトークンを示します。

f056501ada12c1cc

MaxResults

integer

任意

1 ページあたりのレコード数。 有効な値:1~100。

20

WorkspaceId

integer

任意

ワークスペース ID。

12****

レスポンスフィールド

フィールド

説明

object

応答のスキーマ

RequestId

string

リクエスト ID。 この ID を使用して、ログの検索やトラブルシューティングを行うことができます。

3D3FB827-E667-50DB-AD59-C83F8237FECB

Success

boolean

リクエストが成功したかどうかを示します。 有効な値:

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

ErrorCode

string

リクエストが失敗した場合に返されるエラーコード。

UnknownError

ErrorMessage

string

リクエストが失敗した場合に返されるエラーメッセージ。

UnknownError

TableList

array

テーブルの詳細。

DLTable

クエリされたテーブル。

NextToken

string

トークンに関する情報。

NesLoKLEdIZrKhDT7I2gS****

MaxResults

integer

1 ページあたりのレコード数。

20

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。