該接口用于獲取表的字段信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dataworks:* | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| TableGuid | string | 是 | 表的唯一標識。您可以通過調用 GetMetaDBTableList ，獲取表的唯一標識。 | odps.engine_name.table_name |
| PageNum | integer | 否 | 請求獲取的數據頁碼數，用于翻頁。 | 1 |
| PageSize | integer | 否 | 每頁顯示的條數，默認為 10 條，最大 100 條。 | 10 |
| ClusterId | string | 否 | EMR 集群的 ID，您可以登錄 EMR 管理控制臺，獲取集群 ID。 | C-010A704DA760**** |
| DatabaseName | string | 否 | EMR 的數據庫名稱。您可以通過調用 ListMetaDB 接口，獲取數據庫名稱。 | abc |
| TableName | string | 否 | EMR 的表名稱。您可以通過調用 GetMetaDBTableList 接口，獲取表名稱。 | abc |
| DataSourceType | string | 否 | 數據類型，當前僅支持取值為 emr。 | emr |
返回參數
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"ErrorMessage": "The connection does not exist.",
"RequestId": "0bc1ec92159376",
"Success": true,
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Data": {
"PageNum": 1,
"PageSize": 10,
"TotalCount": 100,
"ColumnList": [
{
"ColumnGuid": "odps.engine_name.table_name.name",
"ColumnName": "name",
"IsPartitionColumn": false,
"Comment": "comment ",
"ColumnType": "string",
"IsPrimaryKey": false,
"Position": 1,
"Caption": "data column",
"IsForeignKey": true,
"RelationCount": 2
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter.Meta.CommonError | The specified parameter is invalid. | 請求參數錯誤。 |
| 400 | InvalidParameter.Meta.GuidFormat | The GUID format is invalid. | Guid格式錯誤。 |
| 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 不正確 |
| 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. | DataWorks系統繁忙，請稍后再試。 |
| 429 | Throttling.User | Your request is too frequent. Try again later. | 您的請求過于頻繁，請嘗試放緩請求速度。 |
| 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. | 未知錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史
GetMetaTableColumn 接口的使用示例 Demo 請參見DataWorks OpenAPI 示例。