SearchAcrossCatalog - 跨Catalog搜索元数据

Catalog搜索库、表、字段等内容。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

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

错误码

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

变更历史

更多信息,参考变更详情