调用SearchMetaTables根据条件搜索表。
仅支持搜索MaxCompute和EMR两种类型的引擎表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SearchMetaTables |
系统规定参数。取值:SearchMetaTables。 |
PageNumber | Integer | 否 | 1 |
分页查询页码。 |
PageSize | Integer | 否 | 10 |
每页显示的条数,默认为10条,最大100条。 |
AppGuid | String | 是 | odps.engine_name |
表所在工作空间的标识。 |
Keyword | String | 是 | test |
关键字采用分词匹配算法搜索表名,如果没有匹配的字段则返回空值。默认按照下划线分词搜索。 |
EntityType | Integer | 否 | 0 |
表的类型:0表示table,1表示view。如果不填,则默认搜索全部类型。 |
ClusterId | String | 否 | abc |
EMR集群的ID,仅当数据类型为EMR时,需要配置该参数。 您可以登录EMR的控制台,获取集群ID。 |
DataSourceType | String | 是 | emr |
数据类型,包括ODPS和emr。 |
Schema | String | 否 | default |
表Schema信息。在ODPS,用户启动了三层模型需要填写Schema信息 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
ErrorMessage | String | The specified parameters are invalid. |
错误信息。 |
RequestId | String | 0bc1ec92159376**** |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
ErrorCode | String | 1031203110005 |
错误码。 |
Data | Object |
业务数据。 |
|
PageNumber | Integer | 1 |
分页查询页码。 |
PageSize | Integer | 10 |
分页查询每页的大小。 |
TotalCount | Long | 100 |
表的总数。 |
DataEntityList | Array of DataEntityList |
实例列表。 |
|
TableName | String | test_name |
表的名称。 |
DatabaseName | String | abc |
数据库名称。 |
EntityType | Integer | 0 |
表的类型:
|
ProjectName | String | test |
工作空间的名称。 |
ProjectId | Long | 323 |
工作空间的ID。 |
TableGuid | String | odps.engine_name.test_name |
表的唯一标识。 |
OwnerId | String | 123 |
工作空间Owner的云账号ID。 |
ClusterId | String | abc |
EMR集群ID。 |
EnvType | Integer | 1 |
环境类型:
|
TenantId | Long | 12345 |
租户ID。 |
Schema | String | default |
表Schema信息。在ODPS,用户启动了三层模型需要填写Schema信息 |
示例
请求示例
http(s)://[Endpoint]/?Action=SearchMetaTables
&PageNumber=1
&PageSize=10
&AppGuid=odps.engine_name
&Keyword=test
&EntityType=0
&ClusterId=abc
&DataSourceType=emr
&Schema=default
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SearchMetaTablesResponse>
<HttpStatusCode>200</HttpStatusCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<RequestId>0bc1ec92159376****</RequestId>
<Success>true</Success>
<ErrorCode>1031203110005</ErrorCode>
<Data>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>100</TotalCount>
<DataEntityList>
<TableName>test_name</TableName>
<DatabaseName>abc</DatabaseName>
<EntityType>0</EntityType>
<ProjectName>test</ProjectName>
<ProjectId>323</ProjectId>
<TableGuid>odps.engine_name.test_name</TableGuid>
<OwnerId>123</OwnerId>
<ClusterId>abc</ClusterId>
<EnvType>1</EnvType>
<TenantId>12345</TenantId>
<Schema>default</Schema>
</DataEntityList>
</Data>
</SearchMetaTablesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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"
} ]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 根据ODPS项目获取计算引擎失败。 |
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. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
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.Meta.TenantTimeOut | Failed to connect to the interface network. | 接口网络不通。 |
500 | InternalError.Meta.Unknown | An unknown error occurred while processing your request. | 未知错误。 |
访问错误中心查看更多错误码。
SearchMetaTables接口的使用示例Demo请参见DataWorks OpenAPI示例。