調用GetMetaTableColumn API擷取表的欄位資訊-巨量資料開發治理平台 DataWorks-阿里雲

該介面用於擷取表的欄位資訊。

調試

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

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
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

返回參數

名稱	類型	描述	樣本值
	object	返回結構。
HttpStatusCode	integer	HTTP 狀態代碼。	200
ErrorMessage	string	錯誤資訊。	The connection does not exist.
RequestId	string	請求 ID。用於定位日誌，排查問題。	0bc1ec92159376
Success	boolean	調用是否成功。	true
ErrorCode	string	錯誤碼。	Invalid.Tenant.ConnectionNotExists
Data	object	業務資料。
PageNum	integer	請求擷取的資料頁碼數，用於翻頁。	1
PageSize	integer	每頁顯示的條數，預設為 10 條，最大 100 條。	10
TotalCount	integer	欄位的總數。	100
ColumnList	array<object>	欄位的資訊。
	object	返回結構。
ColumnGuid	string	欄位的唯一標識。	odps.engine_name.table_name.name
ColumnName	string	欄位的名稱。	name
IsPartitionColumn	boolean	欄位是否為分區欄位，取值如下： true，是分區欄位。 false，不是分區欄位。	false
Comment	string	欄位的備忘。	comment
ColumnType	string	欄位的類型。	string
IsPrimaryKey	boolean	欄位是否為主鍵，取值如下： true，是主鍵。 false，不是主鍵。	false
Position	integer	欄位的排序。	1
Caption	string	欄位的描述。	data column
IsForeignKey	boolean	欄位是否為外鍵，取值如下： true，是外鍵。 false，不是外鍵。	true
RelationCount	integer	欄位熱度。	2

樣本

正常返回樣本

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 不正確
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.

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

變更歷史

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