跨Catalog搜索库、表、字段等内容。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dlf:SearchAcrossCatalog |
*全部资源
|
无 | 无 |
请求语法
POST /api/metastore/catalogs/search/search-across-catalog HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
A short description of struct |
|
| SearchText |
string |
否 |
搜索问题 |
tags:tag1 or comment:^iso and name=aliyun and (createTime > "20211111" and createTime < "20211117") and has category |
| SortCriteria |
array |
否 |
排序结构 |
|
| SortCriterion |
否 |
排序结构 |
||
| PageSize |
integer |
否 |
当前查询的页大小 |
1000 |
| PageNumber |
integer |
否 |
当前查询的页号 |
1 |
| CatalogIds | ListString |
否 |
CatalogId 数组,为空则搜索所有 Catalog |
|
| SearchTypes | ListString |
否 |
SearchTypes 数组,可选值为 ALL/CATALOG/DATABASE/TABLE |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| Code |
string |
响应代码 |
OK |
| Message |
string |
响应消息 |
"" |
| RequestId |
string |
请求 ID |
460C862F-BB91-5C04-BC3F-946EEF467862 |
| Success |
boolean |
是否成功 |
True |
| DatabaseResult |
object |
返回的 db 结果 |
|
| Databases |
array<object> |
返回的 DatabaseList |
|
|
object |
数据库信息 |
||
| Database | Database |
返回的 Database |
|
| HighLightList |
array |
返回高亮文本 |
|
|
HighLight |
返回高亮文本 |
||
| TotalCount |
integer |
满足匹配条件的总的 Database 个数 |
11000 |
| TableResult |
object |
返回的 table result |
|
| Tables |
array<object> |
返回的 TableList |
|
|
object |
表结果结构 |
||
| Table | Table |
返回的 Table |
|
| HighLightList |
array |
返回的高亮文本 |
|
|
HighLight |
返回的高亮文本 |
||
| TotalCount |
integer |
满足匹配条件的总的 Table 个数 |
1100 |
| CatalogResult |
object |
返回的 Catalog result |
|
| Catalogs |
array<object> |
catalog 详情 |
|
|
object |
catalog 详情 |
||
| Catalog | Catalog |
catalog 详情 |
|
| HighLightList |
array |
返回高亮文本 |
|
|
HighLight |
高亮文本 |
||
| TotalCount |
integer |
满足匹配条件的总的 Catalog 个数 |
100 |
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。