GetTableInstructions

Retrieves usage instructions and business context for a table, including its business description, summary, and related assets.

Operation description

Retrieves usage instructions and business context for a table. This operation returns an AI-enhanced business description, a table summary, and a list of related assets. This information helps you find tables semantically and understand their usage.

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. You can call the ListDatabases API to obtain this ID.	1***
TableName	string	Yes	The table name.	order_info

Response elements

Element	Type	Description	Example
	object	The response parameters.
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 succeeded. false: The request failed.	true
Data	TableInstructionsVO	The retrieved table instructions.	1001

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "DbId": 0,
    "DbType": "",
    "TableName": "",
    "AssetDescription": "",
    "Summary": "",
    "AssetCreatedGmt": "",
    "AssetModifiedGmt": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.