> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar informações do banco de dados

> Obtenha os metadados de um banco de dados com GET /v2/databases/{database_id}: nome, dono, cluster, RAM alocada, engine e porta, sem o uso ao vivo.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

Requer uma chave de API com o [escopo](/pt-br/api-reference/authentication#escopos) `databases:read`.

Retorna a identidade estática de um banco de dados: nome, proprietário, cluster de hospedagem, RAM alocada, tipo de motor e porta de conexão. Isso é apenas metadado, não inclui uso de recursos em tempo real; use [Obter Status do Banco de Dados](/pt-br/api-reference/endpoint/databases/status) ou [Obter Métricas do Banco de Dados](/pt-br/api-reference/endpoint/databases/metrics) para isso.

Útil para confirmar a configuração de um banco de dados após [Criar Banco de Dados](/pt-br/api-reference/endpoint/databases/create) ou [Editar Banco de Dados](/pt-br/api-reference/endpoint/databases/edit), ou para descobrir em qual cluster ele está antes de contatar o suporte.

## Parâmetros

<ParamField path="database_id" type="string" placeholder="ID do banco de dados" required>
  O ID do banco de dados. Você pode encontrá-lo no dashboard da Square Cloud.
</ParamField>

## Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida: `success` se foi, `error` se não.
</ResponseField>

<ResponseField name="response" type="object">
  O conteúdo da resposta.

  <Expandable title="Alternar objeto">
    <ResponseField name="name" type="string">
      O nome do banco de dados.
    </ResponseField>

    <ResponseField name="id" type="string">
      O ID do banco de dados.
    </ResponseField>

    <ResponseField name="owner" type="string">
      O ID do proprietário do banco de dados.
    </ResponseField>

    <ResponseField name="cluster" type="string">
      O cluster do banco de dados.
    </ResponseField>

    <ResponseField name="ram" type="number">
      O uso de RAM do banco de dados em MB.
    </ResponseField>

    <ResponseField name="type" type="string">
      O tipo do banco de dados (ex: mongodb, postgresql).
    </ResponseField>

    <ResponseField name="port" type="number">
      A porta do banco de dados.
    </ResponseField>

    <ResponseField name="created_at" type="date">
      A data de criação do banco de dados.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Response theme={"system"}
  {
    "status": "success",
    "response": {
      "name": "my-database",
      "id": "db1234567890",
      "owner": "123456789012345678",
      "cluster": "suki-cluster",
      "ram": 1024,
      "type": "mongodb",
      "port": 27017,
      "created_at": "2023-01-15T10:00:00Z"
    }
  }
  ```
</ResponseExample>

## Erros comuns

| Código | HTTP | Significado |
| - | - | - |
| `DATABASE_NOT_FOUND` | 404 | O banco de dados não existe ou não pertence a quem fez a chamada. |

## Relacionados

* CLI: [`squarecloud db info`](/pt-br/cli-reference/databases#squarecloud-db-info)
* SDKs: [`api.databases.get()`](/pt-br/sdks/js/databases) (JavaScript), [`client.databases.get()`](/pt-br/sdks/py/databases) (Python), [`c.Databases.Get()`](/pt-br/sdks/go/databases) (Go)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.