Todos os produtos
Search

Este produto

    :SearchDatabase

    Central de documentação

    :SearchDatabase

    Última atualização: Jul 09, 2026

    Consulta detalhes de bancos 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. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

    Parâmetros da solicitação

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

    Operação a ser executada. Defina o valor como SearchDatabase .

    PageNumber Integer Sim 1

    Número da página retornada.

    SearchKey String Sim testdb

    Palavra-chave para pesquisar o nome do banco de dados.

    Tid Long Sim 1

    ID do locatário.

    Nota Utilize o ID do locatário exibido no canto superior direito do sistema. Para mais detalhes, consulte ID do locatário e Locatário .
    PageSize Integer Não 10

    Número de entradas retornadas por página.

    EnvType String Não product

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

    SearchRange String Não HAS_PERMSSION

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

    • HAS_PERMSSION : Permitido
    • OWNER : De minha propriedade
    • MY_FOCUS : Meus favoritos
    • UNKNOWN : Ilimitado
    SearchTarget String Não SINGLE_DB

    Banco de dados alvo da consulta. Valores válidos:

    • DB : Ilimitado (não distingue entre banco único ou lógico)
    • SINGLE_DB : Banco único
    • LOGIC_DB : Banco lógico
    DbType String Não MySQL

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

    • MySQL
    • SQLServer
    • PostgreSQL
    • Oracle
    • DRDS
    • OceanBase
    • Mongo
    • Redis

    Parâmetros de resposta

    Parâmetro Tipo Exemplo Descrição
    ErrorCode String UnknownError

    Código de erro retornado.

    ErrorMessage String UnknownError

    Mensagem retornada.

    RequestId String E0D21075-CD3E-4D98-8264-FD8AD04A63B6

    ID da solicitação de API.

    SearchDatabaseList Array of SearchDatabase

    Lista de detalhes dos bancos de dados pesquisados.

    SearchDatabase
    Alias String test

    Alias do banco de dados.

    DatabaseId String 1

    ID do banco de dados.

    DatalinkName String datalink_name

    Datalink correspondente ao banco de dados.

    DbType String mysql

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

    • MySQL
    • SQLServer
    • PostgreSQL
    • Oracle
    • DRDS
    • OceanBase
    • Mongo
    • Redis
    DbaId String 1

    ID do DBA do banco de dados.

    Encoding String utf8

    Codificação do banco de dados.

    EnvType String product

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

    Host String xxx.xxx.xxx.xxx

    Endereço de conexão da instância onde o banco de dados está localizado.

    Logic Boolean false

    Indica se é um banco de dados lógico. Valores:

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

    Lista de IDs dos proprietários do banco de dados.

    OwnerNameList List user1

    Lista de apelidos dos proprietários do banco de dados.

    Port Integer 3306

    Porta da instância correspondente ao banco de dados.

    SchemaName String test

    Schema do banco de dados PolarDB-X.

    SearchName String test@xxx.xxx.xxx.xxx:3306

    Nome de pesquisa do banco de dados.

    Sid String testSid

    Sid da instância correspondente ao banco de dados.

    Success Boolean true

    Indica se a solicitação foi bem-sucedida.

    TotalCount Long 1

    Número total de registros que atendem às condições.

    Exemplos

    Exemplos de solicitações

    
     http(s)://[Endpoint]/?Action=SearchDatabase &PageNumber=1 &SearchKey=testdb &Tid=-1 &<Public request parameters>

    Exemplos de respostas de sucesso

    Formato XML 

    
     <TotalCount>1</TotalCount> <RequestId>E0D21075-CD3E-4D98-8264-FD8AD04A63B6</RequestId> <SearchDatabaseList> <SearchDatabase> <Encoding>utf8mb4</Encoding> <Hos t>pc-xxx.mysql.polardb.rds.aliyuncs.com</Host> <DbType>polardb</DbType> <EnvType>dev</EnvType> <OwnerIdList> <OwnerIds>88653</OwnerIds> <OwnerIds> <88656</OwnerIds> </OwnerIds>104442> </OwnerIdList> <Logic>false</Logic> <DbaId>88653</DbaId> <OwnerNameList> <OwnerNames>dmstest</OwnerNames> <OwnerNames>xx</OwnerNames> <OwnerNames>xx [sub-account]</OwnerNames> </OwnerNames> </OwnerNameList> <Port>3306</Port> <<DatabaseId>117567</DatabaseIas <Alixx> <SearchName>xxx@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306 [xx offline library]</SearchName> <DatalinkName>dblink_38</DatalinkName> <SchemaName>xxx_0000</SchemaName> </SearchDatabase> </SearchDatabaseList> <Success>true</Success>

    Formato JSON 

    
     { "TotalCount": 1, "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6", "SearchDatabaseList": { "SearchDatabase": [ { "Encoding": "utf8mb4", "Host": "pc-xxx.mysql.polardb.rds.aliyuncs.com", "DbType": "polardb", "EnvType": "dev", "OwnerIdList": { "OwnerIds": [ 88653, 88656, 104442 ] }, "Logic": false, "DbaId": 88653, "OwnerNameList": { "OwnerNames": ["dmstest", "xx", "xx [sub-account]" ] }, "Port": 3306, "DatabaseId": 117567, "Alias": "xx offline library", "SearchName": "xxx@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306 [xx offline library]", "DatalinkName": "dblink_38", "SchemaName": "xxx_0000" } ] }, "Success": true }

    Códigos de erro

    Acesse o Error Center para ver mais códigos de erro.