调用SearchMetaTables根据条件搜索表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SearchMetaTables

要执行的操作。

AppGuid String odps.engine_name.table_name

表所在工作空间的标识。

DataSourceType String emr

数据类型。odps、emr

Keyword String test

关键字。

RegionId String cn-shanghai

地域ID。

PageNumber Integer 1

分页查询页码。

PageSize Integer 10

分页查询每页的大小。

EntityType Integer 0

表的类型:0表示table,1表示view。如果不填,则默认搜索全部类型。

ClusterId String abc

emr集群id。针对emr情况

返回数据

名称 类型 示例值 描述
Data Struct

业务数据。

DataEntityList Array of DataEntityList

实例列表。

ClusterId String abc

emr集群id

DatabaseName String abc

数据库名称

EntityType Integer 0

表的类型:0表示table,1表示view。

EnvType Integer 1

环境类型:1表示生产环境,0表示开发环境。

OwnerId String 123

工作空间Owner的云账号ID。

ProjectId Long 323

工作空间的ID。

ProjectName String test

工作空间的名称。

TableGuid String odps.engine_name.table_name

表的唯一标识。

TableName String table_name

表的名称。

TenantId Long 12345

租户ID。

PageNumber Integer 1

分页查询页码。

PageSize Integer 10

分页查询每页的大小。

TotalCount Long 100

表的总数。

ErrorCode String success

错误码。

ErrorMessage String success

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0bc1ec92159376****

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=SearchMetaTables
&AppGuid=odps.engine_name.table_name
&DataSourceType=emr
&Keyword=test
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0bc1ec92159376****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <DataEntityList>
        <EntityType>0</EntityType>
        <TableName>table_name</TableName>
        <TableGuid>odps.engine_name.table_name</TableGuid>
        <TenantId>12345</TenantId>
        <OwnerId>123</OwnerId>
        <ProjectName>test</ProjectName>
        <ClusterId>abc</ClusterId>
        <ProjectId>323</ProjectId>
        <DatabaseName>abc</DatabaseName>
        <EnvType>1</EnvType>
    </DataEntityList>
</Data>
<ErrorCode>success</ErrorCode>
<ErrorMessage>success</ErrorMessage>
<Success>true</Success>

JSON 格式

{"RequestId":"0bc1ec92159376****","HttpStatusCode":"200","Data":{"TotalCount":"100","PageSize":"10","PageNumber":"1","DataEntityList":[{"EntityType":"0","TableName":"table_name","TableGuid":"odps.engine_name.table_name","TenantId":"12345","OwnerId":"123","ProjectName":"test","ClusterId":"abc","ProjectId":"323","DatabaseName":"abc","EnvType":"1"}]},"ErrorCode":"success","ErrorMessage":"success","Success":"true"}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,可能是由于您还未激活DataWorks。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
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. 您的请求过于频繁,请尝试放缓请求速度。
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. 当前的用户不是任何租户的所有者。
500 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. 根据ODPS项目{0}获取计算引擎失败。
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. 接口网络不通。
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. 未知错误。
400 Invalid.Meta.TableNotExist The table does not exist. 表不存在。
400 InvalidParameter.Meta.CommonError The specified parameter is invalid. 请求参数错误。
400 InvalidParameter.Meta.GuidFormat The GUID format is invalid. Guid信息错误。
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. 数据不存在。

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