使用GetMetaTableIntroWiki API擷取表的使用說明-巨量資料開發治理平台 DataWorks-阿里雲 - DataWorks

該介面用於取得表的使用說明。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
TableGuid	string	是	表的唯一識別碼。	odps.engine_name.table_name
WikiVersion	integer	否	使用說明的版本。	1

返回參數

名稱	類型	描述	樣本值
	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	業務資料。
ModifiedTime	integer	修改表的時間。格式範例為 13 位數字，例如 `1584444247000`。	1584444247000
Version	integer	版本號。	1
CreateTime	integer	表的建立時間。格式範例為 13 位數字，例如 `1584444247000`。	1584444247000
CreatorName	string	表的建立者名稱。	abc
Content	string	表的描述資訊。	# 業務需求\n\n<a name="xiw5n"
Creator	string	表的建立者。	abc

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "ModifiedTime": 1584444247000,
    "Version": 1,
    "CreateTime": 1584444247000,
    "CreatorName": "abc",
    "Content": "# Business requirements\\n\\n<a name="xiw5n"",
    "Creator": "abc"
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.
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.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.
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.

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

變更歷史

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