> ## 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="app_id" type="string" placeholder="Application ID" required>
  应用程序的 ID。你可以在应用程序控制台的 URL 中找到它。
</ParamField>

<ParamField path="rawData" type="boolean" placeholder="true or false">
  如果你想要原始数据。设为 True 时，返回以字节为单位的值。
</ParamField>

### 响应

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

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

  <Expandable title="展开对象">
    <ResponseField name="cpu" type="string">
      应用程序的 CPU 使用率。
    </ResponseField>

    <ResponseField name="ram" type="string">
      应用程序的 RAM 使用量。
    </ResponseField>

    <ResponseField name="status" type="string">
      应用程序的状态。
    </ResponseField>

    <ResponseField name="running" type="boolean">
      指示应用程序当前是否正在运行。
    </ResponseField>

    <ResponseField name="storage" type="string">
      应用程序使用的存储空间。
    </ResponseField>

    <ResponseField name="network" type="object">
      <Expandable title="展开对象">
        <ResponseField name="total" type="string">
          应用程序的总网络使用量。
        </ResponseField>

        <ResponseField name="now" type="string">
          应用程序当前的网络使用量。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="uptime" type="number">
      应用程序的运行时长，单位为毫秒。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
      "status": "success",
      "response": {
          "cpu": "0.01%",
          "ram": "31.79",
          "status": "running",
          "running": true,
          "storage": "2.72MB",
          "network": {
              "total": "602 KB ↑ 134 KB ↓",
              "now": "14 KB ↑ 3.3 KB ↓"
          },
          "uptime": 1662927833666
      }
  }
  ```
</ResponseExample>