调用GetMetaTableDetailInfo接口获取表的字段与索引详细信息-数据管理 DMS-阿里云-阿里云帮助中心

调用GetMetaTableDetailInfo接口获取表的字段、索引等信息。

接口说明

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

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	123
TableGuid	string	是	表在 DMS 中的唯一识别码 GUID（Globally Unique Identifier）。说明逻辑库：可调用 ListLogicTables 接口获取，需要将 ReturnGuid 参数设置为 true。物理库：可调用 ListTables 接口获取，需要将 ReturnGuid 参数设置为 true。	IDB_L_9032.db-test.yuyang_test

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	E881CB2F-DE42-42E5-90EB-8B3173DCB9B9
DetailInfo	object	表详情。
IndexList	array<object>	索引列表。
Index	object
IndexColumns	array	索引字段列表。
ColumnNames	string	索引字段。	id
IndexName	string	索引名。	PRIMARY
Unique	boolean	是否为唯一索引。取值： true：是唯一索引。 false：不是唯一索引。	false
IndexType	string	索引类型。例如：Primary、Unique、Normal。	Primary
IndexId	string	索引 ID。	123
ColumnList	array<object>	字段列表。
Column	object
ColumnName	string	字段名。	id
Description	string	字段描述。	test
DataScale	integer	该字段小数后的位数。	0
DataPrecision	integer	字段精度。	0
ColumnType	string	字段的数据类型。例如：Bigint 、Int、Varchar。	bigint(20) unsigned
AutoIncrement	boolean	当前字段是否自增。取值： true：自增。 false：不自增。	true
Position	string	字段在表中的顺序。	1
Nullable	boolean	是否可空。取值： true：允许为空。 false：不允许为空。	false
ColumnId	string	字段 ID。	191234849
DataLength	long	字段长度。	0
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "E881CB2F-DE42-42E5-90EB-8B3173DCB9B9",
  "DetailInfo": {
    "IndexList": [
      {
        "IndexColumns": [
          "id"
        ],
        "IndexName": "PRIMARY",
        "Unique": false,
        "IndexType": "Primary",
        "IndexId": 123
      }
    ],
    "ColumnList": [
      {
        "ColumnName": "id",
        "Description": "test",
        "DataScale": 0,
        "DataPrecision": 0,
        "ColumnType": "bigint(20) unsigned",
        "AutoIncrement": true,
        "Position": 1,
        "Nullable": false,
        "ColumnId": 191234849,
        "DataLength": 0
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

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

变更历史

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

暂无变更历史