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

# 获取 DNS 记录

> 获取你自定义域名的 DNS 记录。

**使用此路由前，应用必须已绑定一个自定义域名。** 自定义域名在 [Standard 套餐](https://squarecloud.app/zh/pricing) 及以上提供。此路由的速率限制为每 10 秒 3 次请求。

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

### 响应

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

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

  <Expandable title="展开对象">
    <ResponseField name="type" type="string">
      DNS 记录的类型。
    </ResponseField>

    <ResponseField name="name" type="string">
      DNS 记录的名称。
    </ResponseField>

    <ResponseField name="value" type="string">
      DNS 记录的值。
    </ResponseField>

    <ResponseField name="status" type="string">
      DNS 记录的状态。可以是 `pending_validation`、`pending` 或 `active`。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "status": "success",
    "response": [
      {
        "type": "txt",
        "name": "_acme-challenge.joaootavios.dev",
        "value": "hmo-jMx_KCWQU5CWG6xmrkI4AOZOJXlQtjEtc7zI1PA",
        "status": "pending_validation"
      },
      {
        "type": "cname",
        "name": "joaootavios.dev",
        "value": "cname.squareweb.app",
        "status": "pending"
      }
    ]
  }
  ```
</ResponseExample>