调用ListColumns返回表的列信息。

调试

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

请求参数

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

系统规定参数。取值:ListColumns

Logic Boolean false

是否逻辑表。

TableId String 1

表ID。

Tid Long 0

租户ID。

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

返回数据

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

列信息详情。

Column
AutoIncrement Boolean false

是否自增字段

ColumnId String 1

字段ID

ColumnName String name

字段名

ColumnType String varchar

字段类型

DataLength Long 32

字段长度

DataPrecision Integer 0

字段精度

DataScale Integer 0

字段精度

DefaultValue String def_value

字段默认值

Description String test

字段描述

FunctionType String default

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

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

字段是否可空

SecurityLevel String INNER

安全级别,取值如下:

  • INNER: 内部(非敏感)
  • SENSITIVE: 敏感
  • CONFIDENTIAL: 机密
Sensitive Boolean false

是否敏感字段

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

RequestId String 0AD9AC55-5873-474A-9F33-4285806A3619

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ListColumns
&Logic=false
&TableId=1
&Tid=0
&<公共请求参数>

正常返回示例

XML 格式

<ColumnList>
    <Column>
        <ColumnId>314036829</ColumnId>
        <DataScale>0</DataScale>
        <Sensitive>false</Sensitive>
        <Description>主键ID</Description>
        <DataPrecision>20</DataPrecision>
        <ColumnType>bigint(20) unsigned</ColumnType>
        <ColumnName>id</ColumnName>
        <SecurityLevel>INNER</SecurityLevel>
        <AutoIncrement>true</AutoIncrement>
        <Nullable>false</Nullable>
    </Column>
    <Column>
        <ColumnId>314036830</ColumnId>
        <Sensitive>false</Sensitive>
        <Description>创建时间</Description>
        <DefaultValue>CURRENT_TIMESTAMP</DefaultValue>
        <ColumnType>datetime</ColumnType>
        <ColumnName>gmt_create</ColumnName>
        <SecurityLevel>INNER</SecurityLevel>
        <AutoIncrement>false</AutoIncrement>
        <Nullable>false</Nullable>
    </Column>
    <Column>
        <ColumnId>314036831</ColumnId>
        <Sensitive>false</Sensitive>
        <Description>修改时间</Description>
        <DefaultValue>CURRENT_TIMESTAMP</DefaultValue>
        <ColumnType>datetime</ColumnType>
        <ColumnName>gmt_modified</ColumnName>
        <SecurityLevel>INNER</SecurityLevel>
        <AutoIncrement>false</AutoIncrement>
        <Nullable>false</Nullable>
    </Column>
    <Column>
        <ColumnId>314036832</ColumnId>
        <Sensitive>false</Sensitive>
        <Description>base_user</Description>
        <ColumnType>varchar(64)</ColumnType>
        <DataLength>64</DataLength>
        <ColumnName>user_name</ColumnName>
        <SecurityLevel>INNER</SecurityLevel>
        <AutoIncrement>false</AutoIncrement>
        <Nullable>true</Nullable>
    </Column>
</ColumnList>
<RequestId>0AD9AC55-5873-474A-9F33-4285806A3619</RequestId>
<Success>true</Success>

JSON 格式

{
  "ColumnList": {
    "Column": [
      {
        "ColumnId": 314036829,
        "DataScale": 0,
        "Sensitive": false,
        "Description": "主键ID",
        "DataPrecision": 20,
        "ColumnType": "bigint(20) unsigned",
        "ColumnName": "id",
        "SecurityLevel": "INNER",
        "AutoIncrement": true,
        "Nullable": false
      },
      {
        "ColumnId": 314036830,
        "Sensitive": false,
        "Description": "创建时间",
        "DefaultValue": "CURRENT_TIMESTAMP",
        "ColumnType": "datetime",
        "ColumnName": "gmt_create",
        "SecurityLevel": "INNER",
        "AutoIncrement": false,
        "Nullable": false
      },
      {
        "ColumnId": 314036831,
        "Sensitive": false,
        "Description": "修改时间",
        "DefaultValue": "CURRENT_TIMESTAMP",
        "ColumnType": "datetime",
        "ColumnName": "gmt_modified",
        "SecurityLevel": "INNER",
        "AutoIncrement": false,
        "Nullable": false
      },
      {
        "ColumnId": 314036832,
        "Sensitive": false,
        "Description": "base_user",
        "ColumnType": "varchar(64)",
        "DataLength": 64,
        "ColumnName": "user_name",
        "SecurityLevel": "INNER",
        "AutoIncrement": false,
        "Nullable": true
      }
    ]
  },
  "RequestId": "0AD9AC55-5873-474A-9F33-4285806A3619",
  "Success": true
}

错误码

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