SearchTableAssetKnowledge

Queries a paginated list of asset knowledge related to a specific table. This knowledge includes information about tables, columns, SQL statements, and snippets.

Operation description

Queries a paginated list of asset knowledge related to a specific table. You can filter the results by criteria such as knowledge type and keyword. The API returns a paginated list of KnowledgeBaseVO objects.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DbId	integer	Yes	The ID of the database. Call the ListDatabases API to obtain this ID.	1***
TableName	string	Yes	The name of the table.	order_info
SearchKey	string	No	The keyword for a fuzzy search on knowledge content.	订单
ShowType	string	No	The type of knowledge to return. Valid values: `TABLE`, `COLUMN`, `SQL`, and `SEG`. If this parameter is omitted, all types are returned.	TABLE
Size	integer	No	The number of entries to return per page. The default value is 20.	20
Offset	integer	No	The pagination offset. The default value is 0.	0

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request succeeded. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The paginated asset knowledge results.
TotalCount	integer	The total number of entries.	100
Items	array	A list of asset knowledge items.
	KnowledgeBaseVO	An object that contains the details of an asset knowledge item. Note	[]

Examples

Success response

JSON format

{
  "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": false
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.