调用GetMetaTableColumn获取表的字段信息_数据管理(DMS)-阿里云帮助中心

调用GetMetaTableColumn接口获取表的字段信息。

接口说明

仅管控模式为安全协同的数据库实例可调用此 API。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dms:GetMetaTableColumn	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。	3***
TableGuid	string	是	表在 DMS 中的唯一识别码（Globally Unique Identifier，简称 GUID）。如果数据库为逻辑库，可通过调用接口 ListLogicTables 获取该参数的值。如果数据库为物理库，可通过调用接口 ListTables 获取该参数的值。	IDB_40753****.qntest2.activity_setting

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	087DFBA1-378B-5D25-B13B-31F6409F****
ErrorCode	string	错误码。	MissingTableGuid
ColumnList	object []	字段列表信息。
ColumnType	string	字段的数据类型。说明字段的数据类型返回值不唯一，例如：bigint、int。	bigint(1)
AutoIncrement	boolean	字段是否自增，返回值说明如下： true：自增 false：不自增	false
ColumnId	string	字段 ID。	63513****
ColumnName	string	字段名。	has_promotion
SecurityLevel	string	字段的安全级别，返回值说明如下： INNER：内部（非敏感） SENSITIVE：敏感 CONFIDENTIAL：机密说明更多字段的安全信息，请参见字段安全等级。	INNER
PrimaryKey	string	字段是否为主键，返回值说明如下： true：主键 false：非主键	true
Description	string	字段描述。	是否有优惠活动
DataPrecision	integer	字段精度。	19
DataScale	integer	字段小数位数。	0
Position	integer	字段在表中的顺序。	1
Nullable	boolean	字段是否允许为空，返回值说明如下： true：允许为空 false：不允许为空	false
DataLength	long	字段长度。	0
ErrorMessage	string	错误信息。	TableGuid is mandatory for this action.
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true

示例

正常返回示例

JSON格式

{
  "RequestId": "087DFBA1-378B-5D25-B13B-31F6409F****",
  "ErrorCode": "MissingTableGuid",
  "ColumnList": [
    {
      "ColumnType": "bigint(1)",
      "AutoIncrement": false,
      "ColumnId": "63513****",
      "ColumnName": "has_promotion",
      "SecurityLevel": "INNER",
      "PrimaryKey": "true",
      "Description": "是否有优惠活动",
      "DataPrecision": 19,
      "DataScale": 0,
      "Position": 1,
      "Nullable": false,
      "DataLength": 0
    }
  ],
  "ErrorMessage": "TableGuid is mandatory for this action.",
  "Success": true
}

错误码

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

变更历史

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

暂无变更历史