Method: projects.locations.setDedicatedCrawlRate

为 crawlRateScope 设置专用抓取速度。如果未设置专用抓取速度，则启用 Vertex AI 的抓取机器人以使用新的专用抓取速度进行抓取。如果已设置专用抓取速度，则 Vertex AI 的抓取机器人会尝试将该速度更新为新值。如果新值过高，抓取机器人可能会以较低的速度抓取，以避免用户网站过载。

HTTP 请求

POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}:setDedicatedCrawlRate

网址采用 gRPC 转码语法。

路径参数

参数
location

string

必需。执行抓取速度管理操作的位置资源。格式：projects/{project}/locations/{location}

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "crawlRateScope": string,
  "crawlRate": integer,
  "crawlType": enum (CrawlType),
  "mode": enum (Mode)
}
字段
crawlRateScope

string

必需。用户想要配置的抓取速度的范围。目前，仅支持域名和主机名。域名示例：example.com。主机名示例：www.example.com。请勿在域名或主机名中包含 /。
crawlRate

integer

可选。用户设置的抓取 QPS。无法保证 Vertex 抓取机器人会以该 QPS 进行抓取。如果抓取速度过高，实际 QPS 可能会低于用户设置的值，以避免用户网站过载。
crawlType

enum (CrawlType)

可选。用户触发的抓取速度还是自动刷新的抓取速度。
mode

enum (Mode)

可选。速度是由用户明确设置还是由 Vertex AI 设置。

响应正文

如果成功，则响应正文包含一个 Operation 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

如需了解详情，请参阅 Authentication Overview。

CrawlType

抓取类型用于区分用户触发和自动刷新。用户触发的抓取速度适用于确定性应用场景，例如抓取用户指定的网址或站点地图。自动刷新的抓取速度适用于“尽力而为”应用场景，例如定期刷新网址。

枚举
CRAWL_TYPE_UNSPECIFIED 未指定抓取类型。
USER_TRIGGERED 抓取类型为用户触发。
AUTO_REFRESH 抓取类型为自动刷新。

模式

速度是由用户明确设置还是由 Vertex AI 设置。

枚举
MODE_UNSPECIFIED 未指定模式。如果用户未指定模式，则默认为 AUTOMATIC。
AUTOMATIC Vertex AI 会自动将 crawlRate 分为用户触发和自动刷新。如果模式为 AUTOMATIC，用户无需指定 SetDedicatedCrawlRateRequest.CrawlType。
EXPLICIT 用户明确设置用户触发的抓取速度或自动刷新的抓取速度。