使用GetMetaTableIntroWiki获取表的使用说明-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
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": "# 业务需求\\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.	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.
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.

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

变更历史

更多信息，参考变更详情。