全部產品
Search

搜尋本產品

    DataWorks：GetMetaTableBasicInfo - 擷取表的基礎資訊

    文件中心

    DataWorks：GetMetaTableBasicInfo - 擷取表的基礎資訊

    更新時間：Mar 21, 2026

    該介面用於擷取表的基礎資訊。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dataworks:*

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    TableGuid

    string

    否

    MaxCompute 表的唯一標識。格式為 odps.projectName.tableName。

    說明

    EMR 情境下，該參數非必選。

    odps.engine_name.table_name
    ClusterId

    string

    否

    EMR 叢集的 ID，當 DataSourceType（資料類型）參數配置為 EMR 時，當前參數必配。

    您可以登入 EMR 的控制台，擷取叢集 ID。

    abc
    DatabaseName

    string

    否

    資料庫的名稱。僅當資料類型為 EMR 時，需要配置該參數。

    您可以調用 ListMetaDB 介面擷取。

    abc
    TableName

    string

    否

    EMR 的表名稱。僅當資料類型為 EMR 時，需要配置該參數。

    您可以通過調用 GetMetaDBTableList 介面，擷取表名稱。

    abc
    DataSourceType

    string

    否

    資料類型，包括 odps 和 emr。

    emr
    Extension

    boolean

    否

    是否包含擴充欄位。 擴充欄位包含讀取次數、收藏次數、瀏覽次數等。 僅當資料類型為 ODPS 時，該參數生效。

    false

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    HttpStatusCode

    integer

    請求返回碼。

    200
    ErrorMessage

    string

    錯誤資訊。

    The connection does not exist.
    RequestId

    string

    請求 ID。

    0bc1411515937
    Success

    boolean

    請求是否成功。

    true
    ErrorCode

    string

    錯誤碼。

    Invalid.Tenant.ConnectionNotExists
    Data

    object

    業務資料。

    TableName

    string

    表的名稱。

    table_name
    FavoriteCount

    integer

    表的收藏次數。僅當 Extension 參數取值為 true 時才會返回該參數，並且該參數僅對 odps 資料類型生效。

    6
    Comment

    string

    表的描述。

    test table
    ColumnCount

    integer

    欄位的個數。

    3
    CreateTime

    integer

    建立表的時間。

    1589870294000
    ProjectId

    integer

    工作空間的 ID。

    232
    OwnerId

    string

    表所有者的 ID。

    123
    EnvType

    integer

    環境類型，取值如下：

    • 0 表示開發表。

    • 1 表示生產表。

    1
    DatabaseName

    string

    資料庫的名稱。

    abc
    IsVisible

    integer

    表的可見度：

    • 0 表示目標表對工作空間成員可見。

    • 1 表示目標表對租戶內成員可見。

    • 2 表示目標表對租戶間成員均可見。

    • 3 表示目標表僅對責任人可見。

    1
    TableGuid

    string

    表的唯一標識。

    odps.engine_name.table_name
    ReadCount

    integer

    表的讀取次數。僅當 Extension 參數取值為 true 時才會返回該參數，並且該參數僅對 odps 資料類型生效。

    3
    ClusterId

    string

    EMR 叢集的 ID。

    abc
    IsPartitionTable

    boolean

    是否為分區表，取值如下：

    • true：是分區表。

    • false：不是分區表。

    true
    IsView

    boolean

    是否為視圖，取值如下：

    • true：是視圖。

    • false：不是視圖。

    false
    LifeCycle

    integer

    表的生命週期。單位為天。

    說明

    MaxCompute 表未設定生命週期時，傳回值為 0，表示永久有效

    5
    ProjectName

    string

    工作空間的名稱。

    test
    ViewCount

    integer

    表的瀏覽次數。僅當 Extension 參數取值為 true 時才會返回該參數，並且該參數僅對 odps 資料類型生效。

    2
    LastAccessTime

    integer

    最近一次訪問表的時間。

    1589870294000
    DataSize

    integer

    表佔用的儲存空間。單位為 Byte。

    10
    LastModifyTime

    integer

    最近一次更新表的時間。

    1589870294000
    LastDdlTime

    integer

    最近一次變更表結構的時間。

    1589870294000
    PartitionKeys

    string

    Hive 分區。

    ab
    Location

    string

    Hive 資料庫的儲存地址。

    hdfs://
    Caption

    string

    表的中文名稱。

    中文名
    TenantId

    integer

    租戶 ID。

    12345
    Schema

    string

    表 Schema 資訊。在 ODPS，使用者啟動了三層模型需要填寫 Schema 資訊

    default

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1411515937",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "TableName": "table_name",
    "FavoriteCount": 6,
    "Comment": "test table",
    "ColumnCount": 3,
    "CreateTime": 1589870294000,
    "ProjectId": 232,
    "OwnerId": "123",
    "EnvType": 1,
    "DatabaseName": "abc",
    "IsVisible": 1,
    "TableGuid": "odps.engine_name.table_name",
    "ReadCount": 3,
    "ClusterId": "abc",
    "IsPartitionTable": true,
    "IsView": false,
    "LifeCycle": 5,
    "ProjectName": "test",
    "ViewCount": 2,
    "LastAccessTime": 1589870294000,
    "DataSize": 10,
    "LastModifyTime": 1589870294000,
    "LastDdlTime": 1589870294000,
    "PartitionKeys": "ab",
    "Location": "hdfs://",
    "Caption": "中文名",
    "TenantId": 12345,
    "Schema": "default"
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Invalid.Meta.TableNotExist The table does not exist. 表不存在。
    400 InvalidParameter.Meta.CommonError The specified parameter is invalid. 請求參數錯誤。
    400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. App參數錯誤。
    400 InvalidParameter.Meta.IllegalDate The date format is invalid. 日期格式錯誤。
    400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid. 分頁資訊錯誤。
    400 InvalidParameter.Meta.NotExist The object does not exist.
    400 InternalError.UserId.Missing An internal system error occurred. Try again later.
    400 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. 使用者輸入的 project 不正確
    500 InternalError.System An internal system error occurred. Try again later.
    500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. 介面網路不通。
    500 InternalError.Meta.Unknown An unknown error occurred while processing your request. 未知錯誤。
    403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. 當前的使用者不是任何租戶的所有者。
    403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 沒有許可權，請授權
    429 Throttling.Api The request for this resource has exceeded your available limit.
    429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

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

    變更歷史

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