调用ListColumns返回表的列信息。

调试

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

请求参数

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

系统规定参数。取值:ListColumns

Tid Long 3***

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

TableId String 39281****

表ID,可通过调用接口ListTables获取该参数的值。

Logic Boolean false

是否为逻辑库,取值如下:

  • true:逻辑库
  • false:物理库
RegionId String cn-hangzhou

DMS服务地域,取值请参见RegionID参数说明

返回数据

名称 类型 示例值 描述
RequestId String 0AD9AC55-5873-474A-9F33-4285806A3619

请求ID。

ErrorCode String UnknownError

错误码。

ColumnList Array of Column

列信息详情。

Column
ColumnType String varchar

字段类型。

AutoIncrement Boolean false

当前字段是否自增。返回值如下:

  • true:自增。
  • false:不自增。
ColumnId String 62589****

字段ID。

DefaultValue String def_value

字段默认值。

Sensitive Boolean false

是否敏感字段,返回值如下:

  • true:敏感字段
  • false:非敏感字段
ColumnName String name

字段名。

SecurityLevel String INNER

安全级别,返回值如下:

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

字段描述。

DataPrecision Integer 0

字段的有效数字位数。

DataScale Integer 0

字段的小数位数。

FunctionType String DEFAULT

字段遮掩算法类型,返回值如下:

  • null:无遮掩
  • DEFAULT:全遮掩
  • FIX_POS:固定位置遮掩
  • FIX_CHAR:固定字符替换
Nullable Boolean false

字段是否可空,返回值如下:

  • true:可空
  • false:不可空
DataLength Long 4

字段长度。

ErrorMessage String UnknownError

错误信息。

Success Boolean true

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

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

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListColumns
&Tid=3***
&TableId=39281****
&Logic=false
&公共请求参数

正常返回示例

XML格式

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

<ListColumnsResponse>
    <RequestId>0AD9AC55-5873-474A-9F33-4285806A3619</RequestId>
    <ColumnList>
        <ColumnId>62589****</ColumnId>
        <ColumnName>name</ColumnName>
        <Description/>
        <ColumnType>varchar(4)</ColumnType>
        <AutoIncrement>false</AutoIncrement>
        <SecurityLevel>INNER</SecurityLevel>
        <DataLength>4</DataLength>
        <Sensitive>false</Sensitive>
        <Nullable>false</Nullable>
    </ColumnList>
    <Success>true</Success>
</ListColumnsResponse>

JSON格式

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

{
  "RequestId" : "0AD9AC55-5873-474A-9F33-4285806A3619",
  "ColumnList" : [ {
    "ColumnId" : "62589****",
    "ColumnName" : "name",
    "Description" : "",
    "ColumnType" : "varchar(4)",
    "AutoIncrement" : false,
    "SecurityLevel" : "INNER",
    "DataLength" : 4,
    "Sensitive" : false,
    "Nullable" : false
  } ],
  "Success" : true
}

错误码

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