# OnPage API 资源

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/on_page/resources`

**Tags:** DataForSEO

爬取发现的非页面资源——图片、脚本、样式表——及其状态码和大小。页面使用 `search_after_token` 分页。读取已完成的爬取，因此需要 `post_dataforseo_on_page_submit` 返回的 `id`，并返回 `crawl_progress` 以及 `crawl_status`（`max_crawl_pages`、`pages_in_queue` 和 `pages_crawled`）——在采信偏少的结果前先检查这些字段，因为仍在进行的爬取能报告的内容本来就少。对于爬虫完全无法访问的资源，请使用 `post_dataforseo_on_page_uncrawlable_resources`。💰 上游免费：查询已完成的爬取不产生费用，只有爬取本身计费。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：0.012 美元。
- 参考客户倍率：1.0。不得对已结算的客户金额再次应用。

仅供参考的元数据，不是账户报价、保证价格或消费上限。资源额度不同于 Felo 额度。最终扣费以 Felo 计费记录为准。

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "<em>任务 ID</em><br><strong>必填字段</strong><br>你可以在 <a href=\"/v3/on_page/task_post/\">Task POST</a> 端点的响应中获取此 ID<br>示例：<br>\"07131248-1535-0216-1000-17384017ad04\""
          },
          "url": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>页面 URL</em><br>可选字段<br>如果要获取特定页面的资源，请指定此字段<br>请注意，要从特定 URL 获取资源的 <code>meta</code>，应在此字段中指定该 URL；<br>如果在设置任务时未指定 <code>url</code>，结果中资源的 <code>meta</code> 将基于我们的爬虫首次发现该资源的页面数据返回"
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>返回资源的最大数量</em><br>可选字段<br>默认值：<code>100</code><br>最大值：<code>1000</code>"
          },
          "offset": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>返回资源结果数组中的偏移量</em><br>可选字段<br>默认值：<code>0</code><br>最大值：<code>2000000</code><br>如果指定 <code>10</code>，结果数组中的前十个资源将被省略，数据将针对后续资源提供"
          },
          "filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ]
            },
            "description": "<em>结果筛选参数数组</em><br>可选字段<br><strong>可同时添加多个筛选条件（最多 8 个）</strong><br>应在条件之间设置逻辑运算符 <code>and</code>、<code>or</code><br>支持以下运算符：<br><code>regex</code>、<code>not_regex</code>、<code>&lt;</code>、<code>&lt;=</code>、<code>&gt;</code>、<code>&gt;=</code>、<code>=</code>、<code>&lt;&gt;</code>、<code>in</code>、<code>not_in</code>、<code>like</code>、<code>not_like</code><br>可以将 <code>%</code> 运算符与 <code>like</code> 和 <code>not_like</code> 一起使用，匹配任意长度（零个或多个字符）的字符串<br>示例：<br><code>[\"resource_type\",\"=\",\"stylesheet\"]</code><p><code>[[\"resource_type\",\"=\",\"image\"],<br>\"and\",[\"checks.is_https\",\"=\",false]]</code><p><code>[[\"fetch_timing.duration_time\",\">\",1],\"and\",[[\"total_transfer_size\",\"&gt;\",100],\"or\",[\"checks.high_loading_time\",\"=\",true]]]</code><p>完整可用筛选器列表请见<a href=\"/v3/on_page/filters_and_thresholds/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">此链接。</a>"
          },
          "relevant_pages_filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>按相关页面筛选资源</em><br>可选字段<br>你可以使用此字段获取与所定义参数匹配的页面中的资源<br>此处可应用与 <a href=\"/v3/on_page/pages/\" rel=\"noopener noreferrer\" target=\"_blank\">Pages 端点</a>相同的筛选条件<br><strong>可同时添加多个筛选条件（最多 8 个）</strong><br>应在条件之间设置逻辑运算符 <code>and</code>、<code>or</code><br>支持以下运算符：<br><code>regex</code>、<code>not_regex</code>、<code>&lt;</code>、<code>&lt;=</code>、<code>&gt;</code>、<code>&gt;=</code>、<code>=</code>、<code>&lt;&gt;</code>、<code>in</code>、<code>not_in</code>、<code>like</code>、<code>not_like</code><br>可以将 <code>%</code> 运算符与 <code>like</code> 和 <code>not_like</code> 一起使用，匹配任意长度（零个或多个字符）的字符串<br>示例：<br><code>[\"checks.no_image_title\",\"=\",true]</code>"
          },
          "order_by": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>结果排序规则</em><br>可选字段<br>你可以使用与 <code>filters</code> 数组相同的值对结果排序<br>可用的排序类型：<br><code>asc</code> - 结果将按升序排列<br><code>desc</code> - 结果将按降序排列<br>应使用逗号设置排序参数<br>示例：<br><code>[\"size,desc\"]</code><br><strong>注意，单次请求中最多可设置三条排序规则</strong><br>应使用逗号分隔多条排序规则<br>示例：<br><code>[\"size,desc\",\"fetch_timing.fetch_end,desc\"]</code>"
          },
          "search_after_token": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>后续请求的令牌</em><br>可选字段<br>在每个请求响应的对应字段中提供；<br>使用此参数可避免在单个请求中尝试获取超过 <code>20,000</code> 条结果时超时；<br>通过指定响应数组中的唯一 <code>search_after_token</code> 值，可获取初始任务的后续结果；<br><code>search_after_token</code> 值对每个后续任务都是唯一的；<br><strong>注意：</strong>如果请求中指定了 <code>search_after_token</code>，其他所有参数都应与此前的请求完全相同"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "id": "07281559-0695-0216-0000-c269be8b7592",
            "filters": [
              [
                "resource_type",
                "=",
                "image"
              ],
              "and",
              [
                "size",
                ">",
                100000
              ]
            ],
            "order_by": [
              "size,desc"
            ],
            "limit": 10
          }
        ]
      }
    ]
  },
  "example": [
    {
      "id": "07281559-0695-0216-0000-c269be8b7592",
      "filters": [
        [
          "resource_type",
          "=",
          "image"
        ],
        "and",
        [
          "size",
          ">",
          100000
        ]
      ],
      "order_by": [
        "size,desc"
      ],
      "limit": 10
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 联系 Felo 支持时需提供的请求标识符。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_OnPageResourcesResponseInfo"
    }
  ]
}
```

### 400 — 无法处理该请求。请检查请求参数。

### 401 — 需要有效的 Felo API 密钥。

### 402 — 由于未满足计费要求，请求无法继续。

### 403 — 该账户无权执行此操作。

### 429 — 已达到请求或支出限额。

### 502 — 服务无法完成该请求。

### 503 — API 或计费服务暂时不可用。

### 504 — 服务在处理请求时超时。

### default — 错误响应；上游透传响应可能采用提供方格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseOnPageResourceItem

`#/components/schemas/Response36Afe1097B20_BaseOnPageResourceItem`

```json
{
  "type": "object",
  "properties": {
    "resource_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素类型"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "通用状态码，完整响应码列表见此处。注意：我们强烈建议设计必要的系统来处理相关的异常或错误情况"
    },
    "location": {
      "type": [
        "string",
        "null"
      ],
      "description": "Location 头，表示将页面重定向到的 URL"
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "页面 URL"
    },
    "resource_errors": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_OnPageResourceIssueInfo"
        }
      ],
      "description": "资源错误和警告"
    },
    "size": {
      "type": [
        "integer",
        "null"
      ],
      "description": "资源大小，表示指定页面的字节大小"
    },
    "encoded_size": {
      "type": [
        "integer",
        "null"
      ],
      "description": "编码后的页面大小，表示编码后页面的字节大小"
    },
    "total_transfer_size": {
      "type": [
        "integer",
        "null"
      ],
      "description": "压缩后的页面大小，表示指定页面的压缩后大小",
      "format": "int64"
    },
    "fetch_time": {
      "type": [
        "string",
        "null"
      ],
      "description": "获取资源的日期和时间，采用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”，示例：2019-11-15 12:57:46 +00:00"
    },
    "cache_control": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_CacheControl"
        }
      ],
      "description": "缓存说明"
    },
    "checks": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "boolean",
          "null"
        ]
      },
      "description": "网站检查：与页面相关的页内检查项"
    },
    "content_encoding": {
      "type": [
        "string",
        "null"
      ],
      "description": "编码类型"
    },
    "media_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "用于显示页面的媒体类型"
    },
    "server": {
      "type": [
        "string",
        "null"
      ],
      "description": "服务器版本"
    },
    "last_modified": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_LastModified"
        }
      ],
      "description": "包含与资源相关的变更数据，若无数据，该值为 null"
    }
  },
  "additionalProperties": false,
  "discriminator": {
    "propertyName": "resource_type",
    "mapping": {
      "html": "#/components/schemas/Response36Afe1097B20_OnPageHtmlResourceItem",
      "broken": "#/components/schemas/Response36Afe1097B20_OnPageBrokenResourceItem",
      "redirect": "#/components/schemas/Response36Afe1097B20_OnPageRedirectResourceItem",
      "script": "#/components/schemas/Response36Afe1097B20_OnPageScriptResourceItem",
      "image": "#/components/schemas/Response36Afe1097B20_OnPageImageResourceItem",
      "stylesheet": "#/components/schemas/Response36Afe1097B20_OnPageStylesheetResourceItem"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "API 的当前版本"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "通用状态码\n完整响应码列表见此处"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "通用信息性消息\n完整的一般信息性消息列表见此处"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "总执行时间，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任务总费用，美元",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 数组中的任务数",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 数组中返回错误的任务数",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "任务标识符\n我们系统中 UUID 格式的唯一任务标识符"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "任务的状态码\n由 DataForSEO 生成，范围如下：10000-60000\n完整响应码列表见此处"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "任务的信息性消息\n完整的一般信息性消息列表见此处"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "执行时间，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任务总费用，美元",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "result 数组中的元素数",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL 路径"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "包含你在 POST 请求中指定的相同参数"
    }
  }
}
```

### Response36Afe1097B20_CacheControl

`#/components/schemas/Response36Afe1097B20_CacheControl`

```json
{
  "type": "object",
  "properties": {
    "cachable": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "表示页面是否可缓存"
    },
    "ttl": {
      "type": [
        "integer",
        "null"
      ],
      "description": "生存时间，浏览器缓存资源的时间长度"
    }
  }
}
```

### Response36Afe1097B20_CrawlStatusInfo

`#/components/schemas/Response36Afe1097B20_CrawlStatusInfo`

```json
{
  "type": "object",
  "properties": {
    "max_crawl_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "爬取页面数上限\n 表示设置任务时指定的 max_crawl_pages 限制",
      "format": "int64"
    },
    "pages_in_queue": {
      "type": [
        "integer",
        "null"
      ],
      "description": "当前在爬取队列中的页面数量",
      "format": "int64"
    },
    "pages_crawled": {
      "type": [
        "integer",
        "null"
      ],
      "description": "已爬取的页面数量",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_LastModified

`#/components/schemas/Response36Afe1097B20_LastModified`

```json
{
  "type": "object",
  "properties": {
    "header": {
      "type": [
        "string",
        "null"
      ],
      "description": "标头上次修改的日期和时间\nUTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”\n示例：\n2019-11-15 12:57:46 +00:00\n如果没有数据，该值将为 null"
    },
    "sitemap": {
      "type": [
        "string",
        "null"
      ],
      "description": "站点地图上次修改的日期和时间\nUTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”\n示例：\n2019-11-15 12:57:46 +00:00\n如果没有数据，该值将为 null"
    },
    "meta_tag": {
      "type": [
        "string",
        "null"
      ],
      "description": "元标签上次修改的日期和时间\nUTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”\n示例：\n2019-11-15 12:57:46 +00:00\n如果没有数据，该值将为 null"
    }
  }
}
```

### Response36Afe1097B20_OnPageResourceIssueInfo

`#/components/schemas/Response36Afe1097B20_OnPageResourceIssueInfo`

```json
{
  "type": "object",
  "properties": {
    "errors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_OnPageResourceIssueItemInfo"
          }
        ]
      },
      "description": "资源错误"
    },
    "warnings": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_OnPageResourceIssueItemInfo"
          }
        ]
      },
      "description": "资源警告"
    }
  },
  "description": "资源错误和警告"
}
```

### Response36Afe1097B20_OnPageResourceIssueItemInfo

`#/components/schemas/Response36Afe1097B20_OnPageResourceIssueItemInfo`

```json
{
  "type": "object",
  "properties": {
    "line": {
      "type": [
        "integer",
        "null"
      ],
      "description": "发现错误的行"
    },
    "column": {
      "type": [
        "integer",
        "null"
      ],
      "description": "发现错误的列"
    },
    "message": {
      "type": [
        "string",
        "null"
      ],
      "description": "错误的文本消息：可能的 HTML 错误完整列表可在此处找到"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "通用状态码，完整响应码列表见此处。注意：我们强烈建议设计必要的系统来处理相关的异常或错误情况"
    }
  }
}
```

### Response36Afe1097B20_OnPageResourcesResponseInfo

`#/components/schemas/Response36Afe1097B20_OnPageResourcesResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_OnPageResourcesTaskInfo"
              }
            ]
          },
          "description": "<em>任务数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_OnPageResourcesResultInfo

`#/components/schemas/Response36Afe1097B20_OnPageResourcesResultInfo`

```json
{
  "type": "object",
  "properties": {
    "crawl_progress": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>抓取会话的状态</em><br>可能的值：<code>in_progress</code>、<code>finished</code>"
    },
    "crawl_status": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
        }
      ],
      "description": "<em>抓取会话的详细信息</em>"
    },
    "search_after_token": {
      "type": [
        "string",
        "null"
      ]
    },
    "current_offset": {
      "type": [
        "integer",
        "null"
      ]
    },
    "total_items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>已抓取的相关条目总数</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>结果数组中的条目数</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_BaseOnPageResourceItem"
          }
        ]
      },
      "description": "<em>条目数组</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageResourcesTaskInfo

`#/components/schemas/Response36Afe1097B20_OnPageResourcesTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_OnPageResourcesResultInfo"
              }
            ]
          },
          "description": "<em>结果数组</em>"
        }
      }
    }
  ]
}
```