Queries details of columns in a table.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListColumns

The operation that you want to perform. Valid values: ListColumns .

Logic Boolean Yes false

Indicates whether the table is a logical table.

TableId String Yes 1

The ID of the table.

Tid Long Yes 0

The tenant ID.

Note The tenant ID is taken from the avatar in the upper-right corner of the system. For more information, see Tenant ID and Tenant .

Response parameters

Parameter Type Example Description
ColumnList Array of Column

The details of the column information.

AutoIncrement Boolean false

Indicates whether the column is an auto-increment column. Valid values:

  • true: The column is an auto-increment column.
  • false: The column is not an auto-increment column.
ColumnId String 1

The ID of the column.

ColumnName String name

The name of the column.

ColumnType String varchar

The type of the field.

DataLength Long 32

The length of the column.

DataPrecision Integer 0

The precision of the column.

DataScale Integer 0

The precision of the column.

DefaultValue String def_value

The default value of the column.

Description String test

The description of the column.

FunctionType String default

The masking algorithm type of the field. Valid values:

  • null: No cover-up
  • DEFAULT: full cover
  • FIX_POS: the fixed position is masked.
  • FIX_CHAR: the fixed characters are replaced.
Nullable Boolean true

Whether the field can be empty.

SecurityLevel String INNER

The security level of the field. Valid values:

  • INNER: internal (non-sensitive)
Note For more information, see Field security level .
Sensitive Boolean false

Indicates whether the field is a sensitive field.

ErrorCode String UnknownError

The error code returned.

ErrorMessage String UnknownError

The returned message.

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

The ID of the request.

Success Boolean true

Indicates whether the call was successful.


Sample requests

     http(s)://[Endpoint]/? Action=ListColumns &Logic=false &TableId=1 &Tid=0 &<common request parameters> 

Sample success responses

XML format

     <ColumnList> <Column> <ColumnId>314036829</ColumnId> <DataScale>0</DataScale> <Sensitive>false</Sensitive> <Description> primary key ID</Description> <datapreclient> 20</datapreclient> <ColumnType>bigint(20) unsigned</ColumnType> </ColumnType> columnName> id</ColumnName> <SecurityLevel>INNER</SecurityLevel> <AutoIncrement>true</AutoIncrement> <Nullable>false</Nullable> </Column> <Column> <Column> <Column> <Column id> 314036830</Column id> </Sensitive> <false> </Sensitive> </Sensitive> <Description> /Description> <DefaultValue>CURRENT_TIMESTAMP</DefaultValue> <ColumnType>datetime</ColumnType> <ColumnName>gmt_create</ColumnName> <SecurityLevel>INNER</SecurityLevel> <AutoIncrement>false</AutoIncrement> </AutoIncrement> <nulllevel> false</nullid> </Column> </Column>> 314036831</columnnid> <Sensitive>false</Sensitive> <Description> modification time</Description> <DefaultValue>CURRENT_TIMESTAMP</DefaultValue> <ColumnType>datetime</ColumnType> <ColumnName>gmt_modified</ColumnName> <SecurityLevel>INNER</columnlevel> <SecurityLevel> </SecurityLevel> <automationsecret> <false /AutoIncrement> <Nullable>false</Nullable> </Column> <Column> <Column> <columnnid> 314036832</columnnid> <Sensitive>false</Sensitive> <Description>base_user</Description> <ColumnType>varchar(64)</ColumnType> <DataLength> </datallength> </64> <ColumnName>user_name</ColumnName> <SecurityLevel>INNER</SecurityLevel> <AutoIncrement>false</AutoIncrement> <Nullable>true</Nullable> </Column> </ColumnList> <RequestId> Success> </RequestId> <Success> </cess> 

JSON Format

     {"ColumnList": { "Column": [ { "columnnid": 314036829, "DataScale": 0, "Sensitive": false, "Description": "PRIMARY KEY ID", "datapreclient": 20, "ColumnType": "bigint(20) unsigned", "ColumnName": "" id ", " SecurityLevel ": " INNER ", " AutoIncrement ": true, " Nullable ": false },{" columnnid ": 314036830, " Sensitive ": false, " Description ": " creation time ", " DefaultValue ": " CURRENT_TIMESTAMP ", " ColumnType ": " datetime ", " ColumnName ": " gmt_create ", " SecurityLevel ": " INNER ", " AutoIncrement ": false, " Nullable ": false },{" columnnid ": 314036831, " Sensitive ": false, " Description ": " modification time ", " DefaultValue ": ": "CURRENT_TIMESTAMP", "ColumnType": "datetime", "ColumnName": "gmt_modified", "SecurityLevel": "INNER", "AutoIncrement": false, "Nullable": false },{ "ColumnId": 336814032, "Sensitive": false, "Description": ": " base_user ", " ColumnType ": " varchar(64)", " DataLength ": 64, " ColumnName ": " user_name ", " SecurityLevel ": " INNER ", " AutoIncrement ": false, " Nullable ": true } ] }, " RequestId ": " increment ", " Success ": true} 

Error codes

Go to the Error Center For more information, see error codes.