ListTables API 概要 - DataWorks - Alibaba Cloud - DataWorks - Alibaba Cloud ドキュメントセンター

DataWorks データマップのデータテーブルのリストをクエリします。スキーマレベルをサポートしないタイプの場合、指定されたデータベース配下のデータテーブルをクエリできます。スキーマレベルをサポートするタイプの場合、指定されたデータベース、MaxCompute プロジェクト、またはスキーマ配下のデータテーブルをクエリできます。応答には基本的なテーブル情報のみが含まれ、技術メタデータやビジネスメタデータは含まれません。

操作説明

DataWorks Basic Edition 以上のエディションが必須です。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:ListTables

list

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ParentMetaEntityId	string	必須	親レベルのメタデータエンティティの ID。この値は ListDatabases または ListSchemas 操作の応答から取得できます。詳細については、メタデータエンティティの概念を参照してください。値はテーブルが属するデータベースにセットできます。ParentMetaEntityId のフォーマットは `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}` です。存在しないレベルにはプレースホルダーとして空の文字列を使用してください。値はテーブルが属するデータベーススキーマにもセットできます。ParentMetaEntityId のフォーマットは `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}` です。存在しないレベルにはプレースホルダーとして空の文字列を使用してください。説明 ParentMetaEntityId をデータベーススキーマにセットできるのは、データベースタイプがスキーマをサポートしている場合のみです（`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle`、maxcompute タイプの場合は三層モデルを有効にする必要があります）。それ以外の場合、このパラメーターはデータベースにのみセットできます。 maxcompute および dlf タイプの場合、インスタンス ID にはプレースホルダーとして空の文字列を使用してください。maxcompute タイプの場合、データベース名は MaxCompute プロジェクト名です。 starrocks タイプの場合、データカタログ識別子はカタログ名です。dlf タイプの場合、データカタログ識別子はカタログ ID です。その他のタイプはカタログレベルをサポートしていません。プレースホルダーとして空の文字列を使用してください。以下の例は、一般的なタイプの 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`: URL エンコードされた JDBC 接続文字列。データソースが接続文字列を使用して登録されている場合に必須です。 `catalog_id`: DLF カタログ ID。 `project_name`: MaxCompute プロジェクト名。 `database_name`: データベース名。 `schema_name`: スキーマ名。	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	データテーブルの詳細。

注意:

Tables で返される Table オブジェクトは簡略化された構造であり、以下のプロパティは含まれません:

TechnicalMetadata
BusinessMetadata

テーブルの技術メタデータまたはビジネスメタデータを取得するには、GetTable 操作を呼び出して完全な Table オブジェクトを取得してください。

例

成功レスポンス

JSONJSON

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A****",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Tables": [
      {
        "Id": "dlf-table::catalog_id:database_name::table_name",
        "Name": "table_name",
        "Comment": "测试表",
        "TableType": "TABLE",
        "PartitionKeys": [
          "ds"
        ],
        "ParentMetaEntityId": "dlf-database::catalog_id:database_name",
        "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": "value"
          }
        },
        "BusinessMetadata": {
          "Readme": "## 使用说明",
          "CustomAttributes": {
            "key": [
              "张三"
            ]
          },
          "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
          }
        },
        "StatisticsInfos": {
          "key": ""
        }
      }
    ]
  }
}

エラーコード

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

変更履歴

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