SearchTableAssetKnowledge - 分页查询某张表相关的资产知识列表

更新时间:
复制为 MD 格式

分页查询某张表相关的资产知识列表(含表/字段/SQL/片段等)

接口说明

分页查询某张表相关的资产知识列表,支持按知识类型、关键词等条件筛选,返回 KnowledgeBaseVO 分页结果

调试

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

调试

授权信息

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

请求语法

POST / HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

DbId

integer

数据库 ID,可以调用 ListDatabases 接口获取。

1***

TableName

string

表名

order_info

SearchKey

string

搜索关键词,用于模糊匹配知识内容

订单

ShowType

string

知识展示类型筛选,可选值如 TABLE、COLUMN、SQL、SEG 等,为空表示全部

TABLE

Size

integer

每页返回条数,默认 20

20

Offset

integer

分页偏移量,默认 0

0

返回参数

名称

类型

描述

示例值

object

返回内容

RequestId

string

Id of the request

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

ErrorCode

string

错误码。

UnknownError

ErrorMessage

string

错误信息。

UnknownError

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功

  • false:请求失败

true

Data

object

知识分页结果

TotalCount

integer

总条数

100

Items

array

知识列表

KnowledgeBaseVO

表名,您可以调用 ListTables 接口获取该参数。

说明

该参数必填的情况:ResourceType 的参数值为 META_TABLE 或 LOGIC_TABLE。

[]

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "TotalCount": 100,
    "Items": [
      {
        "KnowledgeId": "",
        "EntityId": 0,
        "KnowledgeType": "",
        "ShowType": "",
        "Category": "",
        "Name": "",
        "Summary": "",
        "OldSummary": "",
        "Description": "",
        "OldDescription": "",
        "Expr": "",
        "InstanceName": "",
        "DbName": "",
        "TableName": "",
        "DbId": 0,
        "Env": "",
        "GmtCreate": "",
        "LevelType": "",
        "ParseDesc": "",
        "RelationType": "",
        "Confidence": 0,
        "ReasoningLogic": "",
        "IsDelete": true
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情