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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetMetaTableColumn

系统规定参数。取值:GetMetaTableColumn

TableGuid String IDB_L_11345.yuyang_test.base_user

表在DMS中的唯一识别码GUID(Globally Unique Identifier)。

说明
  • 逻辑库:可调用ListLogicTables接口获取,需要将ReturnGuid参数设置为true
  • 物理库:可调用ListTables接口获取,需要将ReturnGuid参数设置为true
Tid Long 123

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见 查看租户信息
RegionId String cn-hangzhou

选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
ColumnList Array of Column

字段列表。

AutoIncrement Boolean true

字段是否自增。取值:

  • true:自增。
  • false:不自增。
ColumnId String 191234849

字段ID。

ColumnName String id

字段名。

ColumnType String bigint(20) unsigned

字段的数据类型。例如:Bigint IntVarchar

DataLength Integer 0

字段长度。

DataPrecision Integer 0

字段精度。

DataScale Integer 0

字段小数后的位数。

Description String test

字段描述。

Nullable Boolean false

字段是否允许为空。取值:

  • true:允许为空。
  • false:不允许为空。
Position Integer 1

字段在表中顺序。

PrimaryKey String true

字段是否为主键,取值:

  • true:主键。
  • false:非主键。
SecurityLevel String INNER

字段的安全级别,取值如下:

  • INNER:内部(非敏感)
  • SENSITIVE:敏感
  • CONFIDENTIAL:机密
说明 更多信息,请参见 字段安全等级
ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

RequestId String 2B581A5E-D4FE-4F77-BADE-DD944D7BEBE2

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetMetaTableColumn
&TableGuid=IDB_L_11345.yuyang_test.base_user
&<公共请求参数>

正常返回示例

XML格式

<GetMetaTableColumnResponse>
      <RequestId>2B581A5E-D4FE-4F77-BADE-DD944D7BEBE2</RequestId>
      <ErrorCode>UnknownError</ErrorCode>
      <ColumnList>
            <ColumnId>191234849</ColumnId>
            <ColumnName>id</ColumnName>
            <Description>test</Description>
            <ColumnType>bigint(20) unsigned</ColumnType>
            <Position>1</Position>
            <AutoIncrement>true</AutoIncrement>
            <SecurityLevel>INNER</SecurityLevel>
            <DataScale>0</DataScale>
            <DataLength>0</DataLength>
            <DataPrecision>0</DataPrecision>
            <PrimaryKey>true</PrimaryKey>
            <Nullable>false</Nullable>
      </ColumnList>
      <ErrorMessage>UnknownError</ErrorMessage>
      <Success>true</Success>
</GetMetaTableColumnResponse>

JSON格式

{
	"RequestId": "2B581A5E-D4FE-4F77-BADE-DD944D7BEBE2",
	"ErrorCode": "UnknownError",
	"ColumnList": [{
		"ColumnId": "191234849",
		"ColumnName": "id",
		"Description": "test",
		"ColumnType": "bigint(20) unsigned",
		"Position": "1",
		"AutoIncrement": "true",
		"SecurityLevel": "INNER",
		"DataScale": "0",
		"DataLength": "0",
		"DataPrecision": "0",
		"PrimaryKey": "true",
		"Nullable": "false"
	}],
	"ErrorMessage": "UnknownError",
	"Success": "true"
}

错误码

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