Todos os produtos
Search
Central de documentação

:ListColumns

Última atualização: Jul 08, 2026

Consulta detalhes das colunas de uma tabela.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro Tipo Obrigatório Exemplo Descrição
Action String Sim ListColumns

Operação a ser executada. Valor válido: ListColumns .

Logic Boolean Sim false

Indica se a tabela é lógica.

TableId String Sim 1

ID da tabela.

Tid Long Sim 0

ID do locatário.

Nota Obtenha o ID do locatário no avatar localizado no canto superior direito do sistema. Para mais informações, consulte ID do locatário e Locatário .

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
ColumnList Array of Column

Detalhes das informações da coluna.

Column
AutoIncrement Boolean false

Indica se a coluna possui incremento automático. Valores válidos:

  • true: a coluna possui incremento automático.
  • false: a coluna não possui incremento automático.
ColumnId String 1

ID da coluna.

ColumnName String name

Nome da coluna.

ColumnType String varchar

Tipo do campo.

DataLength Long 32

Comprimento da coluna.

DataPrecision Integer 0

Precisão da coluna.

DataScale Integer 0

Escala da coluna.

DefaultValue String def_value

Valor padrão da coluna.

Description String test

Descrição da coluna.

FunctionType String default

Tipo de algoritmo de mascaramento do campo. Valores válidos:

  • null: sem mascaramento.
  • DEFAULT: mascaramento total.
  • FIX_POS: posição fixa mascarada.
  • FIX_CHAR: caracteres fixos substituídos.
Nullable Boolean true

Indica se o campo aceita valores nulos.

SecurityLevel String INNER

Nível de segurança do campo. Valores válidos:

  • INNER: interno (não sensível).
  • SENSITIVE: sensível.
  • CONFIDENTIAL: confidencial.
Nota Para mais informações, consulte Nível de segurança do campo .
Sensitive Boolean false

Indica se o campo é sensível.

ErrorCode String UnknownError

Código de erro retornado.

ErrorMessage String UnknownError

Mensagem de erro retornada.

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

ID da solicitação.

Success Boolean true

Indica se a chamada foi bem-sucedida.

Exemplos

Exemplos de solicitação


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

Exemplos de resposta de sucesso

Formato XML


     <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> 
   

Formato JSON


     {"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} 
   

Códigos de erro

Acesse o Centro de Erros para consultar os códigos de erro.