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

# Obter status do banco de dados pelo ID

> Retorna o status atual e o uso de recursos de um banco de dados pelo seu ID.

**id** `string` *required*

O ID do banco de dados do qual obter o status. Se o banco de dados pertencer a um workspace, informe o ID dele no parâmetro de query `workspace_id`.

**workspace\_id** `string`

Se o banco de dados pertencer a um workspace, o ID do workspace. Obrigatório para membros do workspace que atuam sobre um banco de dados que não lhes pertence.

> [!NOTE]
>
> **Um banco de dados parado responde `200`, não um erro.** O container de um banco de dados parado não existe — ele é removido ao parar — e isso é um estado normal, não uma falha. A API retorna `200` com `status: "stopped"`, `running: false` e todas as métricas zeradas. Só uma falha real ao ler o status retorna `500`.

### Resposta

**response** `object`

Os detalhes de status e de uso de recursos do banco de dados.

**Mostrar objeto**

**id** `string`

O ID do banco de dados.

**cpu** `string`

Percentual de uso de CPU, já formatado (por exemplo, `12.30%`).

**ram** `string`

Uso de RAM, já formatado (por exemplo, `256.00 MB`).

**storage** `string`

Uso de armazenamento, já formatado (por exemplo, `512.00 MB`).

**status** `string`

O status do banco de dados: `running` ou `stopped`.

**running** `boolean`

Indica se o banco de dados está em execução no momento.

**network** `object`

Detalhes de uso de rede.

**Mostrar objeto**

**total** `string`

Tráfego de rede total desde que o container foi iniciado, de entrada e de saída em uma única string.

**now** `string`

Tráfego de rede atual, de entrada e de saída em uma única string.

**uptime** `number`

O tempo em execução do banco de dados, em segundos.

**created\_at** `string`

A data e hora em que o banco de dados foi criado.

**updated\_at** `string`

A data e hora em que o banco de dados foi atualizado pela última vez.

```json Response theme={null}
{
  "response": {
    "id": "db-abc123def456",
    "cpu": "12.30%",
    "ram": "256.00 MB",
    "storage": "512.00 MB",
    "status": "running",
    "running": true,
    "network": {
      "total": "320.15KB ↓ 20.10KB ↑",
      "now": "5.00KB ↑ 1.00KB ↓"
    },
    "uptime": 7200,
    "created_at": "2026-03-09T15:51:47.234Z",
    "updated_at": "2026-03-11T15:06:41.449Z"
  }
}
```

### Respostas de erro

**code** `string`

O código de erro que indica o motivo da falha. Valores possíveis:

* `DATABASE_NOT_FOUND`: O banco de dados informado não existe.
* `FORBIDDEN`: O usuário não tem permissão para acessar o banco de dados.
* `INTERNAL_SERVER_ERROR`: Não foi possível ler o status. Um banco de dados parado **não** é esse caso — veja a nota acima.

**message** `string`

Uma mensagem descritiva com detalhes adicionais sobre o erro.

```json Error Response (404) theme={null}
{
  "code": "DATABASE_NOT_FOUND"
}
```

```json Error Response (401) theme={null}
{
  "code": "FORBIDDEN"
}
```

```json Error Response (500) theme={null}
{
  "code": "INTERNAL_SERVER_ERROR"
}
```


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