SearchMetaTables_大数据开发治理平台 DataWorks_API文档

2020-05-18

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

仅支持搜索 MaxCompute 和 EMR 两种类型的引擎表。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作
暂无数据

请求参数

字段名称	字段详情
PageNumberinteger<int32>	分页查询页码。示例值:1
PageSizeinteger<int32>	每页显示的条数，默认为 10 条，最大 100 条。示例值:10
AppGuidstring	表所在工作空间的标识。示例值:odps.engine_name
Keywordstring	关键字采用分词匹配算法搜索表名，如果没有匹配的字段则返回空值。默认按照下划线分词搜索。示例值:test
EntityTypeinteger<int32>	表的类型：0 表示 table，1 表示 view。如果不填，则默认搜索全部类型。示例值:0
ClusterIdstring	EMR 集群的 ID，仅当数据类型为 EMR 时，需要配置该参数。展开详情示例值:abc参考取值来源: ListClusters
DataSourceTypestring	数据类型，包括 ODPS 和 emr。示例值:emr参考取值来源: CreateDataSource ExportDataSources ListDataSources
Schemastring	表 Schema 信息。在 ODPS，用户启动了三层模型需要填写 Schema 信息示例值:default

返回参数

字段名称	字段详情
HttpStatusCodeinteger<int32>	请求返回码。示例值:200
ErrorMessagestring	错误信息。示例值:The specified parameters are invalid.
RequestIdstring	请求 ID。示例值:0bc1ec92159376****
Successboolean	请求是否成功。示例值:true
ErrorCodestring	错误码。示例值:1031203110005
Dataobject	搜索结果。

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	Invalid.Meta.TableNotExist	The table does not exist.	诊断
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.	诊断
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.	诊断
403	ResourceNotAuthorized.Api	You are not authorized to access the resources.	诊断
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.	诊断
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.	诊断

变更历史

	变更时间	变更内容概要	操作
	2022-07-19	新增请求参数Schema 变更返回参数

相关示例