Todos os produtos
Search
Central de documentação

:ListTables

Última atualização: Jul 08, 2026

Use esta operação para consultar detalhes das tabelas em um banco de dados.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. Pesquise e chame operações de API, além de gerar dinamicamente códigos de exemplo do SDK com o OpenAPI Explorer.

Parâmetros de solicitação

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

Operação a executar. Valor: ListTables .

DatabaseId String Sim 1

ID do banco de dados.

PageNumber Integer Sim 1

Número da página retornada.

Tid Long Sim -1

ID do locatário.

Nota Obtenha o ID do locatário ao passar o ponteiro do mouse sobre sua foto de perfil. Para mais informações, consulte Visualizar informações do locatário .
PageSize Integer Não 10

Quantidade de entradas a retornar por página.

SearchName String Não test

Palavra-chave ou prefixo para busca de tabelas.

ReturnGuid Boolean Não true

Indica se o GUID da tabela deve ser retornado.

RegionId String Não cn-hangzhou

Parâmetro de solicitação de API baseado na região.

Parâmetros de resposta

**

Parâmetro

**

**

Tipo

**

**

Resposta de exemplo

**

**

Descrição

**

ErrorCode

String

UnknownError

Códigos de erro.

ErrorMessage

String

UnknownError

Mensagem de erro da falha.

RequestId

String

B16FB618-5E96-4FFD-BB0D-490C890A4030

ID da solicitação.

Success

Boolean

true

Indica se a chamada foi bem-sucedida.

TableList

Array of Table

Detalhes das tabelas.

Table

DatabaseId

String

1

ID do banco de dados.

Description

String

test

Descrição da tabela.

Encoding

String

utf8

Codificação da tabela.

Engine

String

innodb

Mecanismo da tabela.

NumRows

Long

1

Número de linhas na tabela. Valor estatístico; não representa a quantidade exata de linhas.

OwnerIdList

List

1

IDs dos proprietários da tabela.

OwnerNameList

List

owner_name

Apelidos dos proprietários da tabela.

StoreCapacity

Long

1024

Espaço de armazenamento ocupado pela tabela. Valor estatístico; não representa o espaço exato.

TableGuid

String

IDB_308302.yuyang_test.test_ch

GUID da tabela.

TableId

String

1

ID da tabela.

TableName

String

test

Nome da tabela.

TableSchemaName

String

test_db

Nome do banco de dados ao qual a tabela pertence.

TableType

String

NORMAL

Tipo da tabela. Valor padrão: NORMAL.

TotalCount

Long

12

Total de tabelas que atenderam aos critérios de consulta.

Exemplos

Exemplo de solicitação


     http(s)://[Endpoint]/? Action=ListTables &DatabaseId=1 &PageNumber=1 &Tid=-1 &<common request parameters> 
   

Exemplos de respostas de sucesso

Formato XML


     <TableList> <Table> <TableSchemaName>yuyang_test</TableSchemaName> <OwnerNameList> <OwnerNames>xxx</OwnerNames> <OwnerNames>xxx</OwnerNames> </OwnerNameList> <DatabaseId>116367</DatabaseId> <Encoding>utf8mb4</Encoding> <NumRows>3</NumRows> <StoreCapacity>1</StoreCapacity> <TableName>base_user</TableName> <TableGuid>IDB_18396363.yuyang_test.base_user</TableGuid> <TableType>NORMAL</TableType> <OwnerIdList> <OwnerIds>88653</OwnerIds> <OwnerIds>104442</OwnerIds> </OwnerIdList> <Engine>InnoDB</Engine> <TableId>18396363</TableId> </Table> <Table> <TableSchemaName>yuyang_test</TableSchemaName> <OwnerNameList> <OwnerNames>xxx</OwnerNames> <OwnerNames>xxx</OwnerNames> </OwnerNameList> <DatabaseId>116367</DatabaseId> <Encoding>utf8mb4</Encoding> <NumRows>2</NumRows> <StoreCapacity>1</StoreCapacity> <TableName>biz_orders</TableName> <TableType>NORMAL</TableType> <OwnerIdList> <OwnerIds>88653</OwnerIds> <OwnerIds>104442</OwnerIds> </OwnerIdList> <Engine>InnoDB</Engine> <TableId>18390459</TableId> </Table> </TableList> <TotalCount>12</TotalCount> <RequestId>B16FB618-5E96-4FFD-BB0D-490C890A4030</RequestId> <Success>true</Success> 
   

JSON


     { "TableList": { "Table": [ { "TableSchemaName": "yuyang_test", "OwnerNameList": { "OwnerNames": [ "xxx", "xxx" ] }, "DatabaseId": 116367, "Encoding": "utf8mb4", "NumRows": 3, "StoreCapacity": 1, "TableName": "base_user", "TableGuid": "IDB_18396363.yuyang_test.base_user", "TableType": "NORMAL", "OwnerIdList": { "OwnerIds": [ 88653, 104442 ] }, "Engine": "InnoDB", "TableId": 18396363 }, { "TableSchemaName": "yuyang_test", "OwnerNameList": { "OwnerNames": [ "xxx", "xxx" ] }, "DatabaseId": 116367, "Encoding": "utf8mb4", "NumRows": 2, "StoreCapacity": 1, "TableName": "biz_orders", "TableType": "NORMAL", "OwnerIdList": { "OwnerIds": [ 88653, 104442 ] }, "Engine": "InnoDB", "TableId": 18390459 } ] }, "TotalCount": 12, "RequestId": "B16FB618-5E96-4FFD-BB0D-490C890A4030", "Success": true } 
   

Códigos de erro

Para mais informações sobre códigos de erro, consulte o centro de erros.