调用GetTableKnowledgeInfo API获取表的元数据知识-数据管理 DMS-阿里云-阿里云帮助中心

获取指定guid的元数据知识

接口说明

仅开启安全托管的数据库实例可调用此 API。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:GetTableKnowledgeInfo	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
TableSchemaName	string	否	表模式名，仅当 SQLServer 需要传递为架构名。	dbo
DbId	integer	是	物理库 ID，您可以调用 SearchDatabase 接口获取该值。	325
TableName	string	是	表名。	table_name

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。请求的唯一标识，用于定位日志，排查问题。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Table	TableKnowledgeInfo	表的详细信息。	bill_orders

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Table": {
    "TableName": "",
    "Description": "",
    "AssetDescription": "",
    "Summary": "",
    "ColumnList": [
      {
        "ColumnName": "",
        "Description": "",
        "ColumnType": "",
        "Position": 0,
        "AssetDescription": "",
        "AssetModifiedGmt": ""
      }
    ],
    "AssetModifiedGmt": ""
  }
}

错误码

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