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

调试

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

请求参数

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

系统规定参数。取值:GetMetaTableColumn

Tid Long 3***

租户ID,可通过调用接口GetUserActiveTenant获取该参数的值。

TableGuid String IDB_40753****.qntest2.activity_setting

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

  • 如果数据库为逻辑库,可通过调用接口ListLogicTables获取该参数的值。
  • 如果数据库为物理库,可通过调用接口ListTables获取该参数的值。
RegionId String cn-hangzhou

DMS服务地域,请您根据应用所在地就近选择。取值请参见RegionID参数说明

返回数据

名称 类型 示例值 描述
RequestId String 087DFBA1-378B-5D25-B13B-31F6409F****

请求ID。

ErrorCode String MissingTableGuid

错误码。

ColumnList Array of Column

字段列表信息。

ColumnType String bigint(1)

字段的数据类型。

说明 字段的数据类型返回值不唯一,例如:bigintint
AutoIncrement Boolean false

字段是否自增,返回值说明如下:

  • true:自增
  • false:不自增
ColumnId String 63513****

字段ID。

ColumnName String has_promotion

字段名。

SecurityLevel String INNER

字段的安全级别,返回值说明如下:

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

字段是否为主键,返回值说明如下:

  • true:主键
  • false:非主键
Description String 是否有优惠活动

字段描述。

DataPrecision Integer 19

字段精度。

DataScale Integer 0

字段小数位数。

Position Integer 1

字段在表中的顺序。

Nullable Boolean false

字段是否允许为空,返回值说明如下:

  • true:允许为空
  • false:不允许为空
DataLength Long 0

字段长度。

ErrorMessage String TableGuid is mandatory for this action.

错误信息。

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetMetaTableColumn
&TableGuid=IDB_40753****.qntest2.activity_setting
&Tid=3***
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetMetaTableColumnResponse>
    <RequestId>087DFBA1-378B-5D25-B13B-31F6409F****</RequestId>
    <ColumnList>
        <ColumnId>63513****</ColumnId>
        <ColumnName>has_promotion</ColumnName>
        <Description>是否有优惠活动</Description>
        <ColumnType>bigint(1)</ColumnType>
        <Position>1</Position>
        <AutoIncrement>false</AutoIncrement>
        <SecurityLevel>INNER</SecurityLevel>
        <DataScale>0</DataScale>
        <DataPrecision>19</DataPrecision>
        <PrimaryKey>true</PrimaryKey>
        <Nullable>false</Nullable>
    </ColumnList>
    <ColumnList>
        <ColumnId>63513****</ColumnId>
        <ColumnName>consumption_limit</ColumnName>
        <Description>消费额限制</Description>
        <ColumnType>int(11)</ColumnType>
        <Position>2</Position>
        <AutoIncrement>false</AutoIncrement>
        <SecurityLevel>INNER</SecurityLevel>
        <DataScale>0</DataScale>
        <DataPrecision>10</DataPrecision>
        <PrimaryKey>false</PrimaryKey>
        <Nullable>false</Nullable>
    </ColumnList>
    <ColumnList>
        <ColumnId>63513****</ColumnId>
        <ColumnName>quota</ColumnName>
        <Description>发放优惠券额度</Description>
        <ColumnType>int(11)</ColumnType>
        <Position>3</Position>
        <AutoIncrement>false</AutoIncrement>
        <SecurityLevel>INNER</SecurityLevel>
        <DataScale>0</DataScale>
        <DataPrecision>10</DataPrecision>
        <PrimaryKey>false</PrimaryKey>
        <Nullable>false</Nullable>
    </ColumnList>
    <Success>true</Success>
</GetMetaTableColumnResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "087DFBA1-378B-5D25-B13B-31F6409F****",
  "ColumnList" : [ {
    "ColumnId" : "63513****",
    "ColumnName" : "has_promotion",
    "Description" : "是否有优惠活动",
    "ColumnType" : "bigint(1)",
    "Position" : 1,
    "AutoIncrement" : false,
    "SecurityLevel" : "INNER",
    "DataScale" : 0,
    "DataPrecision" : 19,
    "PrimaryKey" : true,
    "Nullable" : false
  }, {
    "ColumnId" : "63513****",
    "ColumnName" : "consumption_limit",
    "Description" : "消费额限制",
    "ColumnType" : "int(11)",
    "Position" : 2,
    "AutoIncrement" : false,
    "SecurityLevel" : "INNER",
    "DataScale" : 0,
    "DataPrecision" : 10,
    "PrimaryKey" : false,
    "Nullable" : false
  }, {
    "ColumnId" : "63513****",
    "ColumnName" : "quota",
    "Description" : "发放优惠券额度",
    "ColumnType" : "int(11)",
    "Position" : 3,
    "AutoIncrement" : false,
    "SecurityLevel" : "INNER",
    "DataScale" : 0,
    "DataPrecision" : 10,
    "PrimaryKey" : false,
    "Nullable" : false
  } ],
  "Success" : true
}

错误码

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