使用 Lookup API

概览

通过 Lookup API,您的客户端应用可以检查网址是否包含在任何 Web Risk 列表中。

检查网址

如要检查某个网址是否在 Web Risk 列表中,请向 uris.search 方法发送 HTTP GET 请求:

  • Lookup API 支持每个请求一个网址。如要检查多个网址,您需要对每个网址发送单独的请求。
  • 您可以通过重复 threatTypes 字段在单个请求中指定多个威胁类型。例如:

    &threatTypes=SOCIAL_ENGINEERING&threatTypes=MALWARE
    
  • 网址必须有效(请参阅 RFC 2396),但无需进行规范化。

  • 如果您使用 REST API,则必须对 GET 参数(如 URI)进行编码。

  • HTTP GET 响应会返回匹配的威胁类型(如果有)以及缓存到期时间。

示例:uris.search

HTTP 方法和网址:

GET "https://webrisk.googleapis.com/v1/uris:search?threatTypes=MALWARE&uri=http%3A%2F%2Ftestsafebrowsing.appspot.com%2Fs%2Fmalware.html"

如需发送请求,请选择以下方式之一:

curl

执行以下命令:

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
""https://webrisk.googleapis.com/v1/uris:search?threatTypes=MALWARE&uri=http%3A%2F%2Ftestsafebrowsing.appspot.com%2Fs%2Fmalware.html""

PowerShell

执行以下命令:

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri ""https://webrisk.googleapis.com/v1/uris:search?threatTypes=MALWARE&uri=http%3A%2F%2Ftestsafebrowsing.appspot.com%2Fs%2Fmalware.html"" | Select-Object -Expand Content

您应会收到如下所示的 JSON 响应:

{
  "threat": {
    "threatTypes": [
      "MALWARE"
    ],
    "expireTime": "2019-07-17T15:01:23.045123456Z"
  }
}

如果没有与您的请求相符的结果,您将收到 {} 的空 JSON 响应。也就是说,您提供的网址不在任何威胁列表中。

缓存时长

expireTime 字段表示匹配应被视为过期的时间戳。如需了解详情,请参阅缓存

后续步骤

了解如何使用 Update API