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

# Obter status do banco de dados

> Obtenha CPU, RAM, rede, armazenamento e uptime ao vivo de um banco de dados com GET /v2/databases/{database_id}/status. Passe rawData=true para números.

<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 estatísticas de execução em tempo real para um único banco de dados: CPU, RAM, uso de rede, armazenamento e tempo de atividade. Passe `rawData=true` para obter valores numéricos brutos em vez das strings formatadas (`"0.54%"`, `"111.32MB"`) mostradas no exemplo abaixo, útil quando você quer fazer sua própria formatação ou cálculo no lado do cliente.

Para obter isso de todos os bancos de dados de uma vez, use [Status de Todos os Bancos de Dados](/pt-br/api-reference/endpoint/databases/status-all). Para tendências históricas em vez de uma leitura ao vivo, veja [Obter Métricas do Banco de Dados](/pt-br/api-reference/endpoint/databases/metrics).

## Parâmetros

<ParamField path="database_id" type="string" placeholder="ID do banco de dados" required>
  O ID do banco de dados.
</ParamField>

<ParamField query="rawData" type="boolean" placeholder="true ou false">
  Quando `true`, `cpu`, `ram` e os demais valores vêm como números em vez de strings formatadas.
</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="cpu" type="string">
      A porcentagem atual de uso da CPU.
    </ResponseField>

    <ResponseField name="ram" type="string">
      A RAM em uso, por exemplo `"120.4MB"`. Não inclui o limite alocado.
    </ResponseField>

    <ResponseField name="running" type="boolean">
      Valor booleano indicando se está em execução.
    </ResponseField>

    <ResponseField name="storage" type="string">
      O armazenamento atual que está sendo utilizado.
    </ResponseField>

    <ResponseField name="network" type="object">
      O uso de rede e o total utilizado.

      <Expandable title="Alternar objeto">
        <ResponseField name="total" type="string">
          O total utilizado.
        </ResponseField>

        <ResponseField name="now" type="string">
          O uso atual.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="uptime" type="int">
      O timestamp representando o tempo de atividade (uptime).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={"system"}
  {
      "status": "success",
      "response": {
          "cpu": "0.54%",
          "ram": "111.32MB",
          "status": "running",
          "running": true,
          "storage": "210.1MB",
          "network": {
              "total": "16.83KB ↑ 126B ↓",
              "now": "0B ↑ 0B ↓"
          },
          "uptime": 1755028584438
      }
  }
  ```
</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 status`](/pt-br/cli-reference/databases#squarecloud-db-status)
* SDKs: [`api.databases.status()`](/pt-br/sdks/js/databases) (JavaScript), [`client.databases.status()`](/pt-br/sdks/py/databases) (Python), [`c.Databases.Status()`](/pt-br/sdks/go/databases) (Go)


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