全部產品
Search
文件中心

MaxCompute:GetTableInfo - 擷取表資訊

更新時間:Dec 18, 2025

查看MaxCompute內部表、視圖、外部表格、聚簇表或Transactional表的資訊。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

odps:GetTableInfo

get

*Project

acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName}

請求文法

GET /api/v1/projects/{projectName}/tables/{tableName} HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

projectName

string

待查看錶或視圖的所屬專案名稱。

odps_project

tableName

string

待查看錶或視圖的名稱。

sale_detail

請求參數

名稱

類型

必填

描述

樣本值

schemaName

string

待查看錶或視圖的所屬 Schema 名稱。

default

type

string

待查看錶或視圖的類型。取值:

  • internal:內部表。

  • external:外部表格。

  • view:視圖。

  • materializedView物化視圖

internal

返回參數

名稱

類型

描述

樣本值

object

請求返回參數。

requestId

string

請求 ID。

0a06dd4516687375802853481ec9fd

data

object

請求返回結果。

name

string

表或視圖名稱。

sale_detail

owner

string

表或視圖的所有者帳號資訊。

ALIYUN$odps****@aliyunid.com

type

string

表或檢視類型。取值:

  • internal:內部表。

  • external:外部表格。

  • view:視圖。

  • materializedView物化視圖

internal

schema

string

表或視圖的所屬 Schema 名稱。

default

creationTime

integer

建立時間。

2022-01-17T07:07:47Z

viewText

string

產生視圖的語句,當類型為視圖時有此傳回值。

select shop_name, sum(total_price) from sale_detail group by shop_name

displayName

string

展示名稱。

odps_project.default.sale_detail

projectName

string

表或視圖的所屬專案名稱。

odps_project

lastDDLTime

integer

表或視圖的 DDL 最後變更時間。

2023-11-21T02:05:56Z

lastModifiedTime

integer

表或視圖的資料最後變更時間。

2023-11-21T02:05:56Z

lastAccessTime

integer

表或視圖的資料最後訪問時間,當表為非分區表時有此傳回值。

說明

該資料從 2023 年 7 月陸續升級採集,在升級後沒有被訪問過或者通過 ALGO 作業、Hologres 直讀方式訪問的無法採集到 last_access_time。

2023-11-21T02:05:56Z

lifecycle

string

生命週期(天)。

-1

isExternalTable

boolean

是否為外部表格,當類型為表時有此傳回值。

false

size

integer

如果表為非分區表,值為表的資料量大小。如果表為分區表,系統不會計算表的資料量大小,值為 NULL。PARTITIONS 視圖中包含分區表各個分區的資料量大小。單位:位元組(Byte)。

5372

comment

string

表注釋。

sale_detail

tableLabel

string

表的敏感等級標籤。更多資訊請參見 Label 許可權控制

0

createTableDDL

string

建立表的 DDL 語句。

create table if not exists sale_detail( shop_name STRING, customer_id STRING, total_price DOUBLE) partitioned by (sale_date STRING, region STRING);

nativeColumns

array<object>

欄位資訊。

object

欄位資訊。

name

string

列名。

shop_name

type

string

資料類型。

STRING

label

string

列的敏感等級標籤。更多資訊請參見 Label 許可權控制

0

comment

string

列注釋。

商店名稱

partitionColumns

array<object>

分區列資訊,分區表才有此傳回值。

object

分區列資訊。

name

string

分區名。

ds='20190130'

type

string

資料類型。

STRING

label

string

列的敏感等級標籤。更多資訊請參見 Label 許可權控制

0

comment

string

分區列注釋。

銷售日期

materializedView

boolean

是否為 物化視圖

false

rewriteEnabled

boolean

是否允許通過物化視圖執行查詢改寫操作,當類型為物化視圖時有此傳回值。

false

autoRefreshEnabled

boolean

是否開啟自動重新整理物化視圖,當類型為物化視圖時有此傳回值。

false

isOutdated

boolean

是否因為源表資料有變化,導致物化視圖資料無效,當類型為物化視圖時有此傳回值。

false

physicalSize

integer

物理大小。

2763

fileNum

integer

檔案數量。

200

storageHandler

string

外部表格解析器,當類型為外部表格時有此傳回值。

com.aliyun.odps.CsvStorageHandler

location

string

外部表格地址,當類型為外部表格時有此傳回值。

oss://oss-cn-hangzhou-internal.aliyuncs.com/oss-mc-test/Demo1/

odpsPropertiesRolearn

string

RAM 中 AliyunODPSDefaultRole 的 ARN 資訊,當類型為外部表格時有此傳回值。

acs:ram::xxxxx:role/aliyunodpsdefaultrole

tablestoreColumnsMapping

string

描述 MaxCompute 將訪問的 Tablestore 表的列,包括主鍵和屬性列,當類型為外部表格時有此傳回值。

o_orderkey,o_orderdate,o_custkey,o_orderstatus,o_totalprice

tablesotreTableName

string

需要訪問的 Tablestore 表名稱,當類型為外部表格時有此傳回值。

ots_tpch_orders

odpsSqlTextOptionFlushHeader

boolean

是否忽略表頭,當類型為外部表格時有此傳回值。

true

odpsTextOptionHeaderLinesCount

integer

忽略表頭前 N 行,當類型為外部表格時有此傳回值。

1

clusterInfo

object

聚簇屬性,當表類型為聚簇表時有此傳回值。

clusterType

string

表的聚簇(Clustering)類型,MaxCompute 當前支援 Hash ClusteringRange Clustering兩種類型。

Hash

clusterCols

array

聚簇欄位(Cluster Key)。

string

聚簇欄位(Cluster Key)。

col_1

sortCols

array<object>

排序欄位。

object

排序欄位。

name

string

排序欄位名稱。

col_2

order

string

排序方式。

DESC

bucketNum

integer

可選欄位,Cluster 表的 Bucket 數目,0 表示作業執行時動態決定。

1024

樣本

正常返回樣本

JSON格式

{
  "requestId": "0a06dd4516687375802853481ec9fd",
  "data": {
    "name": "sale_detail",
    "owner": "ALIYUN$odps****@aliyunid.com",
    "type": "internal",
    "schema": "default",
    "creationTime": 0,
    "viewText": "select shop_name, sum(total_price) from sale_detail group by shop_name",
    "displayName": "odps_project.default.sale_detail",
    "projectName": "odps_project",
    "lastDDLTime": 0,
    "lastModifiedTime": 0,
    "lastAccessTime": 0,
    "lifecycle": "-1",
    "isExternalTable": false,
    "size": 5372,
    "comment": "sale_detail",
    "tableLabel": "0",
    "createTableDDL": "create table if not exists sale_detail( shop_name STRING, customer_id STRING, total_price DOUBLE) partitioned by (sale_date STRING, region STRING);",
    "nativeColumns": [
      {
        "name": "shop_name",
        "type": "STRING",
        "label": "0",
        "comment": "商店名稱"
      }
    ],
    "partitionColumns": [
      {
        "name": "ds='20190130'",
        "type": "STRING",
        "label": "0",
        "comment": "銷售日期"
      }
    ],
    "materializedView": false,
    "rewriteEnabled": false,
    "autoRefreshEnabled": false,
    "isOutdated": false,
    "physicalSize": 2763,
    "fileNum": 200,
    "storageHandler": "com.aliyun.odps.CsvStorageHandler",
    "location": "oss://oss-cn-hangzhou-internal.aliyuncs.com/oss-mc-test/Demo1/",
    "odpsPropertiesRolearn": "acs:ram::xxxxx:role/aliyunodpsdefaultrole",
    "tablestoreColumnsMapping": "o_orderkey,o_orderdate,o_custkey,o_orderstatus,o_totalprice",
    "tablesotreTableName": "ots_tpch_orders",
    "odpsSqlTextOptionFlushHeader": true,
    "odpsTextOptionHeaderLinesCount": 1,
    "clusterInfo": {
      "clusterType": "Hash",
      "clusterCols": [
        "col_1"
      ],
      "sortCols": [
        {
          "name": "col_2",
          "order": "DESC"
        }
      ],
      "bucketNum": 1024
    }
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情