GetDataTrackJobTableMeta - 获取数据追踪表元数据信息 - 数据管理 DMS

获取数据追踪表元数据信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
OrderId	long	是	工单 ID，可通过调用接口 ListOrders 获取该参数的值。	12345
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。	3***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
TableMetaList	array<object>	表元数据信息列表。
TableMeta	object	表元数据信息。
SchemaName	string	数据库名称。	DB165
TableName	string	表名。	live_stat
Columns	array<object>	字段信息列表。
Column	object	字段信息。
ColumnName	string	字段名。	claimantno
ColumnPosition	integer	字段的位置。	1
ColumnType	string	字段的数据类型。例如：BIGINT 、INT、VARCHAR。	BIGINT
Fictive	boolean	字段是否是虚拟列。取值： true false	false
Charset	string	字符集名称。	utf8mb4

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "TableMetaList": [
    {
      "SchemaName": "DB165",
      "TableName": "live_stat",
      "Columns": [
        {
          "ColumnName": "claimantno",
          "ColumnPosition": 1,
          "ColumnType": "BIGINT",
          "Fictive": false,
          "Charset": "utf8mb4"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史