Todos os produtos
Search
Central de documentação

:SearchTable

Última atualização: Jul 09, 2026

Consulta detalhes de tabelas.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Elemento Tipo Obrigatório? Observações Descrição
Action String Sim SearchTable

Operação a ser executada. Valores válidos: SearchTable .

Tid Long Não 1

ID do tenant.

Nota Utilize o ID do tenant exibido no canto superior direito do sistema. Para mais detalhes, consulte ID do Tenant e Tenant .
SearchKey String Sim test

Palavra-chave para buscar o nome da tabela.

PageNumber Integer Não 1

Número da página retornada.

PageSize Integer Não 10

Número de entradas retornadas por página.

EnvType String Sim PRODUCT

Tipo de ambiente do banco de dados. Para mais informações, consulte Descrição do ambiente da instância .

SearchTarget String Sim LOGIC_TABLE

Tipo de tabela a ser buscado. Valores válidos:

  • TABLE : tabela, incluindo tabelas físicas e lógicas
  • SINGLE_TABLE : tabela física
  • LOGIC_TABLE : tabela lógica
SearchRange String Sim OWNER

Permissão sobre o banco de dados. Valores válidos:

  • HAS_PERMSSION : Com permissão
  • OWNER : De minha propriedade
  • MY_FOCUS : Meus favoritos
  • UNKNOWN : sem restrições
DbType String Sim MySQL

Tipo da instância de banco de dados. Valores válidos:

  • MySQL
  • SQLServer
  • PostgreSQL
  • Oracle
  • DRDS
  • OceanBase
  • Mongo
  • Redis
ReturnGuid Boolean Não false

Indica se o GUID da tabela deve ser retornado.

Parâmetros de resposta

Elemento Tipo Resposta de exemplo Descrição
ErrorCode String UnknownError

Código de erro retornado.

ErrorMessage String UnknownError

Mensagem retornada.

RequestId String 1489257F-1B5D-4B5B-89EF-923C12CEEBD1

ID da solicitação.

SearchTableList Array of SearchTable

Lista de detalhes das tabelas pesquisadas.

SearchTable
DBSearchName String test

Nome de busca do banco de dados associado à tabela.

DatabaseId String 1

ID do banco de dados ao qual a tabela pertence.

DbName String test

Schema do banco de dados PolarDB-X.

DbType String mysql

Tipo da instância de banco de dados. Valores válidos:

  • MySQL
  • SQLServer
  • PostgreSQL
  • Oracle
  • DRDS
  • OceanBase
  • Mongo
  • Redis
Description String test

Descrição da instância.

Encoding String utf8

Codificação da tabela.

Engine String innodb

Engine da tabela.

EnvType String test

Tipo de ambiente.

Logic Boolean false

Indica se é uma tabela lógica. Valores válidos:

  • true : Sim
  • false : Não
OwnerIdList List 1

Lista de IDs dos proprietários da tabela.

OwnerNameList List user

Lista de apelidos dos proprietários da tabela.

TableGuid String IDB_L_9032.db-test.yuyang_test

GUID da tabela.

TableId String 1

ID da tabela.

TableName String test_table

Nome da tabela.

TableSchemaName String test@xxx.xxx.xxx.xxx:3306

Nome do banco de dados correspondente à tabela.

Success Boolean true

Indica se a chamada foi bem-sucedida.

TotalCount Long 1

Número total de registros que atendem aos critérios de busca.

Exemplos

Exemplos de solicitações


     http(s)://[Endpoint]/?Action=SearchTable &<Public request parameters> 
   

Exemplos de respostas de sucesso

Formato XML


     <SearchTableList> <SearchTable> <TableGuid>IDB_L_9032.db-test.yuyang_test</TableGuid> <Logic>false</Logic> <TableSchemaName>xxx_0000</TableSchemaName> <OwnerNameList> <OwnerNames>xxx</OwnerNames> <OwnerNames>xxx</OwnerNames> <OwnerNames> <xxx</OwnerNames> </OwnerNames> </OwnerNames> </OwnerNameList> <DBSearchName>xxx_0000@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306 [xxx offline library] </DBSearchName> <DatabaseId>117567</DatabaseId> <Encoding>utf8mb4</Encoding> <TableName>test_aaaa</TableName> <OwnerIdList> <OwnerIds>88653</OwnerIds> <OwnerIds>88656</OwnerIds> <OwnerIds>104442</OwnerIds>> <TableId>18396767</TableId> </SearchTable> </SearchTableList> <TotalCount>1</TotalCount> <RequestId> String </RequestId> <Success>true</Success> 
   

Formato JSON


     { "SearchTableList": { "SearchTable": [ { "TableGuid" : "IDB_L_9032.db-test.yuyang_test", "Logic": false, "TableSchemaName": "xxx_0000", "OwnerNameList": { "OwnerNames": [ "xxx", "xxx", "xxx" ] }, "DBSearchName": "xxx_0000@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306 [xxx offline library]", "DatabaseId": 117567, "Encoding": "utf8mb4", "TableName": "test_aaaa", "OwnerIdList": { "OwnerIds": [ 88653, 88656, 104442 ] }, "EnvType": "dev", "Engine": "InnoDB", "TableId": 18396767 } ] }, "TotalCount": 1, "RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1", "Success": true } 
   

Códigos de erro

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