テーブルメタデータ用の GetTable API リファレンス - DataWorks - Alibaba Cloud - DataWorks

操作説明

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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	string	必須	ID です。ListTables API のレスポンスおよびメタデータエンティティに関連する概念をご参照ください。形式： `${EntityType}:${インスタンス ID またはエスケープされた URL}:${カタログ識別子}:${データベース名}:${テーブル名}`。存在しないレベルにはプレースホルダーとして空文字列を使用してください。説明 MaxCompute および DLF タイプの場合、インスタンス ID のプレースホルダーとして空文字列を使用してください。説明 StarRocks のカタログ識別子はカタログ名、DLF タイプのカタログ識別子はカタログ ID です。その他のタイプはカタログレベルをサポートしていないため、プレースホルダーとして空文字列を使用してください。説明 MaxCompute の場合、データベース名は MaxCompute プロジェクト名を指します。プロジェクトでスキーマが有効になっている場合は、スキーマ名を指定する必要があります。それ以外の場合は、スキーマ名のプレースホルダーとして空文字列を使用してください。一般的な 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 タイプの場合、プロジェクトでスキーマが有効になっている場合にのみ必須です。それ以外の場合は、プレースホルダーとして空文字列を使用してください。 `table_name`：テーブル名。	maxcompute-table:::project_name:[schema_name]:table_name
IncludeBusinessMetadata	boolean	任意	ビジネスメタデータを含めるかどうかを指定します。デフォルト： false。	true

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスです。
RequestId	string	リクエスト ID です。	7B3435F4-2D91-XXX
Success	boolean	リクエストが成功したかどうかを示します。	true
Table	Table	テーブルの詳細情報です。

例

成功レスポンス

JSONJSON

{
  "RequestId": "7B3435F4-2D91-XXX",
  "Success": true,
  "Table": {
    "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl",
    "Name": "test_tbl",
    "Comment": "测试表",
    "TableType": "TABLE",
    "PartitionKeys": [
      "ds"
    ],
    "ParentMetaEntityId": "maxcompute-schema:123456XXX::test_project_with_schema:default\nmaxcompute-project:123456XXX::test_project_without_schema\ndlf-database:123456XXX:test_catalog:test_db\nhms-database:c-abc123xxx::test_db\nholo-schema:h-abc123xxx::test_db:test_schema",
    "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": "{\\\"k1\\\":\\\"v1\\\"}"
      }
    },
    "BusinessMetadata": {
      "Readme": "## 使用说明",
      "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
      }
    }
  }
}

エラーコード

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

変更履歴

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