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

# 获取数据库信息

> 检索特定数据库的详细信息。

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  你账户的 API 密钥。你可以在[账户设置](https://squarecloud.app/zh/account/security)中找到它。
</ParamField>

### 参数

<ParamField path="database_id" type="string" placeholder="Database ID" required>
  数据库的 ID。你可以在 Square Cloud 控制面板中找到它。
</ParamField>

### 响应

<ResponseField name="status" type="string">
  指示调用是否成功。成功时为 `success`，否则为 `error`。
</ResponseField>

<ResponseField name="response" type="object">
  响应的内容。

  <Expandable title="切换对象">
    <ResponseField name="name" type="string">
      数据库的名称。
    </ResponseField>

    <ResponseField name="id" type="string">
      数据库的 ID。
    </ResponseField>

    <ResponseField name="owner" type="string">
      数据库所有者的 ID。
    </ResponseField>

    <ResponseField name="cluster" type="string">
      数据库所在的集群。
    </ResponseField>

    <ResponseField name="ram" type="number">
      数据库的 RAM 使用量，单位为 MB。
    </ResponseField>

    <ResponseField name="type" type="string">
      数据库的类型（例如 mongodb、postgresql）。
    </ResponseField>

    <ResponseField name="port" type="number">
      数据库的端口。
    </ResponseField>

    <ResponseField name="created_at" type="date">
      数据库的创建日期。
    </ResponseField>
  </Expandable>
</ResponseField>

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