SearchTenantTableKnowledge - Data Management - Alibaba Cloud Documentation Center

Operation description

Searches for related tables across databases under a tenant based on natural language. You do not need to specify a dbId. Returns a list of structured TableKnowledgeVO entries.

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
Query	string	Yes	The natural language description for searching tables.	Help me find tables related to user orders.
Model	string	No	The name of the model to use. Only Qwen series models are supported.	qwen-plus
DbId	string	No	The database ID. This parameter is optional. If specified, tables are searched within the specified database. If not specified, tables are searched across all databases at the tenant level.	78459741
Limit	integer	No	The maximum number of table knowledge entries to return. Default value: 20. Maximum value: 50.	20
SessionId	string	No	The session ID. This parameter is optional.	48363552-225c-4c93-aeab-ea9b9d064b96

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	Id of the request	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request was successful.	true
Data	array	The list of table knowledge entries.
	TableKnowledgeVO	The paginated result of table knowledge entries.	true

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": [
    {
      "TableId": 0,
      "TableName": "",
      "DbId": 0,
      "DbName": "",
      "DbType": "",
      "InstanceId": 0,
      "InstanceName": "",
      "SchemaName": "",
      "EnvType": "",
      "Description": "",
      "AssetDescription": "",
      "Summary": "",
      "Title": "",
      "AssetCreatedGmt": "",
      "AssetModifiedGmt": "",
      "Size": 0,
      "NumRows": 0,
      "Level": 0,
      "HotLevel": 0,
      "LevelType": "",
      "Logic": false
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.