GetTable

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:GetTable

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
Id	string	是	ID，可參考 ListTables 介面返回結果，以及中繼資料實體相關概念說明。格式為`${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`: JDBC 連線串的 URLEncode 編碼,對應資料來源以連線串方式註冊時需要提供 `catalog_id`: dlf 目錄 ID `project_name`: maxcompute 專案名稱 `database_name`: 資料庫名稱 `schema_name`: schema 名稱，對於 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	資料表的詳細資訊。

樣本

正常返回樣本

JSON格式

{
  "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": ""
    }
  }
}

錯誤碼

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

變更歷史

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