调用SearchMetaTables接口搜索表-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

该接口用于根据条件搜索表。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	分页查询页码。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大 100 条。	10
AppGuid	string	否	表所在工作空间的标识。	odps.engine_name
Keyword	string	是	关键字采用分词匹配算法搜索表名，如果没有匹配的字段则返回空值。默认按照下划线分词搜索。	test
EntityType	integer	否	表的类型：0 表示 table，1 表示 view。如果不填，则默认搜索全部类型。	0
ClusterId	string	否	EMR 集群的 ID，仅当数据类型为 EMR 时，需要配置该参数。您可以登录 EMR 的控制台，获取集群 ID。	abc
DataSourceType	string	否	数据类型，包括 ODPS 和 emr。	emr
Schema	string	否	表 Schema 信息。在 ODPS，用户启动了三层模型需要填写 Schema 信息	default

返回参数

名称	类型	描述	示例值
	object	返回结果。
HttpStatusCode	integer	请求返回码。	200
ErrorMessage	string	错误信息。	The specified parameters are invalid.
RequestId	string	请求 ID。	0bc1ec92159376****
Success	boolean	请求是否成功。	true
ErrorCode	string	错误码。	1031203110005
Data	object	搜索结果。
PageNumber	integer	分页查询页码。	1
PageSize	integer	分页查询每页的大小。	10
TotalCount	integer	表的总数。	100
DataEntityList	array<object>	查询返回的表列表。
	object	表详情。
TableName	string	表的名称。	test_name
DatabaseName	string	数据库名称。	abc
EntityType	integer	表的类型： 0 表示 table。 1 表示 view。	0
ProjectName	string	工作空间的名称。	test
ProjectId	integer	工作空间的 ID。	323
TableGuid	string	表的唯一标识。	odps.engine_name.test_name
OwnerId	string	工作空间 Owner 的云账号 ID。	123
ClusterId	string	EMR 集群 ID。	abc
EnvType	integer	环境类型： 1 表示生产环境。 0 表示开发环境。	1
TenantId	integer	租户 ID。	12345
Schema	string	表 Schema 信息。在 ODPS，用户启动了三层模型需要填写 Schema 信息	default

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0bc1ec92159376****",
  "Success": true,
  "ErrorCode": "1031203110005",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "DataEntityList": [
      {
        "TableName": "test_name",
        "DatabaseName": "abc",
        "EntityType": 0,
        "ProjectName": "test",
        "ProjectId": 323,
        "TableGuid": "odps.engine_name.test_name",
        "OwnerId": "123",
        "ClusterId": "abc",
        "EnvType": 1,
        "TenantId": 12345,
        "Schema": "default"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
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.	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	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.

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

变更历史

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