GetMetaTableIntroWiki - 获取表的使用说明 - 大数据开发治理平台 DataWorks

该接口用于获取表的使用说明。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
TableGuid	string	是	表的唯一标识。	odps.engine_name.table_name
WikiVersion	long	否	使用说明的版本。	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	long	修改表的时间。	1584444247000
Version	long	版本号。	1
CreateTime	long	表的创建时间。	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": "# 业务需求\\n\\n&lt;a name=&quot;xiw5n&quot;",
    "Creator": "abc"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
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.	-
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.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.	用户输入的 project 不正确
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	接口网络不通。
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	未知错误。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史

GetMetaTableIntroWiki 接口的使用示例 Demo 请参见DataWorks OpenAPI 示例。