GetTableInstructions - 获取表使用说明-数据管理 DMS-阿里云帮助中心

查询表的业务知识/使用说明（业务描述、摘要、关联资产）

接口说明

查询表的业务知识/使用说明，返回 AI 增强业务描述、表业务摘要、关联资产列表，用于辅助语义找表与表用法说明

调试

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

调试

授权信息

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

请求语法

POST / HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
DbId	integer	是	数据库 ID，可以调用 ListDatabases 接口获取。	1***
TableName	string	是	表名	order_info

返回参数

名称	类型	描述	示例值
	object	返回内容
RequestId	string	Id of the request	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
Data	TableInstructionsVO	返回的数据信息。	1001

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。