すべてのプロダクト
Search

このプロダクト

    DataWorks:GetTable

    ドキュメントセンター

    DataWorks:GetTable

    最終更新日:Sep 03, 2026

    データマップ内の指定されたテーブルの詳細を取得します。ビジネスメタデータを返すかどうかを選択できます。

    操作説明

    1. この特徴を使用するには、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:GetTable

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Id

    string

    必須

    テーブルの ID です。この値は ListTables 操作の応答から取得できます。詳細については、「メタデータエンティティの概念」を参照してください。

    フォーマットは ${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}:${TableName} です。存在しないレベルにはプレースホルダーとして空の文字列を使用してください。

    説明

    MaxCompute および DLF タイプの場合、インスタンス ID のプレースホルダーとして空の文字列を使用してください。

    説明

    StarRocks の場合、データカタログ識別子はカタログ名です。DLF の場合、データカタログ識別子はカタログ ID です。その他のタイプではカタログレベルはサポートされていません。プレースホルダーとして空の文字列を使用してください。

    説明

    MaxCompute の場合、データベース名は MaxCompute プロジェクト名です。3 レイヤーモデルが有効なプロジェクトではスキーマ名が必要です。3 レイヤーモデルが無効なプロジェクトでは、スキーマ名のプレースホルダーとして空の文字列を使用してください。

    以下は、一般的なタイプの ID フォーマットの例です。

    maxcompute-table:::project_name:[schema_name]:table_name

    dlf-table::catalog_id:database_name::table_name

    hms-table:instance_id::database_name::table_name

    holo-table:instance_id::database_name:schema_name:table_name

    mysql-table:(instance_id|encoded_jdbc_url)::database_name::table_name

    説明

    ここで
    instance_id: インスタンス ID です。データソースがインスタンスモードで登録されている場合に必須です。
    encoded_jdbc_url: URL エンコードされた JDBC 接続文字列です。データソースが接続文字列を使用して登録されている場合に必須です。
    catalog_id: DLF カタログ ID です。
    project_name: MaxCompute プロジェクト名です。
    database_name: データベース名です。
    schema_name: スキーマ名です。MaxCompute の場合、プロジェクトで 3 レイヤーモデルが有効な場合にのみ必須です。それ以外の場合は、プレースホルダーとして空の文字列を使用してください。
    table_name: テーブル名です。



















    このパラメーターを取得するための推奨プロシージャ: まず、ListCrawlers を呼び出してメタデータクローラーの MetaEntityId を取得します。DLF や StarRocks などデータカタログレベルを含むタイプの場合は、ListCatalogs を呼び出してカタログ ID を取得します。次に、ListDatabases を呼び出してデータベース ID を取得します。必要に応じて、ListSchemas を呼び出してスキーマ ID を取得します。最後に、ListTables を呼び出して対象のテーブル ID を取得し、返されたテーブル ID をこの操作の Id として使用します。

    maxcompute-table:::プロジェクト名:[schema_name]:table_name
    IncludeBusinessMetadata

    boolean

    任意

    ビジネスメタデータを含めるかどうかを指定します。デフォルト値: false。

    true
    IncludeExtendedProperties

    boolean

    任意

    拡張プロパティを返すかどうかを指定します。拡張プロパティを返す場合はこのパラメーターを true に設定し、返さない場合は false に設定します。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    RequestId

    string

    リクエスト ID。

    7B3435F4-2D91-XXX
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    Table Table

    テーブルの詳細。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "7B3435F4-2D91-XXX",
  "Success": true,
  "Table": {
    "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": ""
    }
  }
}

    エラーコード

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

    変更履歴

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