验证响应数据

本文档介绍了如何配置拨测，以验证 HTTP 响应代码和受检查资源发送的响应数据。默认情况下，HTTP 拨测会验证响应代码是否为 2xx。此外，默认情况下不会验证响应数据。不过，您可以修改这些设置。例如，您可以配置 HTTP 拨测以接受 2xx 和 3xx 响应代码。对于所有拨测，您都可以指定如需使拨测成功，响应数据必须包含或不得包含的值。

此功能仅适用于 Google Cloud 项目。对于 App Hub 配置，请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。

如何验证响应数据

您可以在创建或修改拨测时，配置 Cloud Monitoring 以验证来自受检查资源的响应数据。

Google Cloud 控制台

如需创建验证响应数据的拨测，请执行以下操作：

在 Google Cloud 控制台中，前往拨测页面：
前往拨测

如果您使用搜索栏查找此页面，请选择子标题为监控的结果。
在 Google Cloud 控制台的工具栏中，选择您的 Google Cloud 项目。对于 App Hub 配置，请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。
点击创建拨测。
输入标题，然后点击下一步。
输入目标值，然后点击下一步。
配置响应验证：
- 如需验证响应数据，请确保显示已启用内容匹配功能，然后填充与响应验证相关的字段。如需了解这些选项，请参阅本文档的下一部分。
- 对于 HTTP 拨测，请配置可接受的响应代码。默认情况下，HTTP 拨测会将任何 2xx 响应标记为成功响应。
点击下一步，然后完成拨测配置。

Cloud Monitoring API

如需配置拨测以验证响应数据，请填充 UptimeCheckConfig 对象的 contentMatchers 数组。

ContentMatcher 对象包含以下字段：

matcher：描述比较的执行方式。如需查看值列表，请参阅 ContentMatcherOption。

请勿使用 CONTENT_MATCHER_OPTION_UNSPECIFIED 值。
content：存储要在响应数据中搜索的值。该值是字符串字面量或正则表达式。
jsonPathMatcher：存储 JsonPathMatcher 对象，该对象描述要搜索的 JSONpath 以及要如何执行比较。

除非拨测要验证特定 JSONpath，否则请忽略此字段。

本文档的其余部分将介绍如何使用内容匹配选项。

用于验证响应数据的选项

本部分介绍了可用于验证受检查资源发送的响应的字符串匹配策略。对于每种策略，您都需要指定一个值，并指明在响应数据中找到该值后，拨测是通过还是失败。

可能不会搜索来自受检查资源的整个响应：

HTTP 和 HTTPS 拨测：搜索前 4 MB 的内容。
TCP 拨测：搜索前 1 MB 的内容。

搜索字面量子字符串

Google Cloud 控制台

如需配置拨测，使其在响应数据包含某个字面量子字符串时通过，请使用以下设置：

在响应内容匹配类型菜单中选择包含。
在响应内容字段中输入相应的字面量子字符串。
如需验证配置，请点击测试。

如需配置拨测，使其在响应数据包含某个字面量子字符串时失败，请使用以下设置：

在响应内容匹配类型菜单中选择不包含。
在响应内容字段中输入相应的字面量子字符串。
如需验证配置，请点击测试。

Cloud Monitoring API

如需配置拨测，使其在响应数据包含某个字面量子字符串时通过，请使用以下值：

...
"contentMatchers": [
    {
      "content": "Set to the string to be matched.",
      "matcher": "CONTAINS_STRING"
    }
],
...

如需配置拨测，使其在响应数据包含某个字面量子字符串时失败，请使用以下值：

...
"contentMatchers": [
    {
      "content": "Set to the string to be matched.",
      "matcher": "NOT_CONTAINS_STRING"
    }
],
...

下表显示了针对不同响应数据、测试字符串和测试类型的拨测状态：

		拨测状态
响应数据	测试字符串	包含	不包含
`abcd`	`abcd`	通过	未通过
`abc`	`abcd`	未通过	通过
`abc`	`a`	通过	未通过
`Uptime Checks`	`Uptime`	通过	未通过
`Uptime Checks`	`uptime`	未通过	通过

在上表中，响应数据列描述了受检查资源返回的数据，而测试字符串列中列出了相应的字符串字面量。接下来的两列分别指定了测试类型和拨测结果。

使用正则表达式进行搜索

Google Cloud 控制台

如需配置拨测，使其在响应数据与某个正则表达式匹配时通过，请使用以下设置：

在响应内容匹配类型菜单中选择与正则表达式匹配。
在响应内容字段中输入相应的正则表达式。
如需验证配置，请点击测试。

如需配置拨测，使其在响应数据与某个正则表达式匹配时失败，请使用以下设置：

在响应内容匹配类型菜单中选择与正则表达式不匹配。
在响应内容字段中输入相应的正则表达式。
如需验证配置，请点击测试。

Cloud Monitoring API

如需配置拨测，使其在响应数据与某个正则表达式匹配时通过，请使用以下值：

...
"contentMatchers": [
    {
      "content": "Set to the regular expression to be matched.",
      "matcher": "MATCHES_REGEX"
    }
],
...

如需配置拨测，使其在响应数据与某个正则表达式匹配时失败，请使用以下值：

...
"contentMatchers": [
    {
      "content": "Set to the regular expression to be matched.",
      "matcher": "NOT_MATCHES_REGEX"
    }
],
...

下表显示了针对不同响应数据、正则表达式和测试类型的拨测状态：

		拨测状态
响应数据	正则表达式	匹配正则表达式	与正则表达式不匹配
`abcd`	`abcd`	通过	未通过
`Uptime Checks`	`[uU]ptime`	通过	未通过
`Uptime Checks`	`[a-z]{6}`	未通过	通过
`Uptime Checks`	`[a-zA-Z]{6}`	通过	未通过

在上表中，响应数据列描述了受检查资源返回的数据，而正则表达式列中列出了相应的正则表达式。接下来的两列分别指定了测试类型和拨测结果。

在 JSON 响应中搜索特定字段

您可以配置拨测以验证 JSONpath。选择 JSONpath 测试时，测试会将路径值与某个数字、字符串字面量或正则表达式进行比较：

将 JSONpath 与数字或字符串字面量进行比较
将 JSONpath 与正则表达式进行比较

指定 JSONpath 时，您必须先使用 $. 指定根对象，然后再指定特定的字段标识符。如果 JSON 响应包含元素数组，请使用英文方括号 [] 来标识要匹配的特定数组元素。以下示例展示了路径语法：

$.type 与根对象的 type 字段匹配。
$.[0].address.city 与 JSON 响应的第一个数组元素中存储的 address 对象中的 city 字段匹配。
$.content[0].phone 与 content 字段的第一个数组元素的 phone 字段匹配。content 字段是根对象的子级。

您可以配置拨测，以匹配多个字段。请考虑以下 JSON：

[
  {
    ...
    "address": {
      ...
      "city": "Gwenborough",
      "geo": {
        "lat": "-37.3159",
        "lng": "81.1496"
      }
    },
  },
  ...
]

如需匹配第一个数组元素中 geo 字段的整个路径，请将 JSONpath 设置为 $.[0].address.geo，然后在内容字段中输入完整值：

{
  "lat": "-37.3159",
  "lng": "81.1496"
}

如果您有兴趣尝试这些选项，请找到一个返回 JSON 响应的公开网站。

将 JSONpath 与数字或字符串字面量进行比较

Google Cloud 控制台

如需配置拨测，使其在响应数据中的特定 JSONpath 与某个字符串字面量匹配时通过，请使用以下设置：

在响应内容匹配类型菜单中选择与 JSONPath 中的内容匹配。
在 JSONPath 字段中输入路径。
在响应内容字段中输入数字或字符串字面量。
如需验证配置，请点击测试。

如需配置拨测，使其在响应数据中的特定 JSONpath 与某个字符串字面量匹配时失败，请使用以下设置：

在响应内容匹配类型菜单中选择与 JSONPath 中的内容不匹配。
在 JSONPath 字段中输入路径。
在响应内容字段中输入数字或字符串字面量。
如需验证配置，请点击测试。

Cloud Monitoring API

如需配置拨测，使其在 JSON 格式的响应中的特定字段与某个数字或字符串字面量匹配时通过，请为 ContentMatcher 对象使用以下值：

...
"contentMatchers": [
    {
       "content" : "Set to a number, a boolean, or the string to be matched.",
       "matcher" : "MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "EXACT_MATCH"
    }
],
...

如需配置拨测，使其在 JSON 格式的响应中的特定字段与某个数字或字符串字面量匹配时失败，请为 ContentMatcher 对象使用以下值：

...
"contentMatchers": [
    {
       "content" : "Set to a number, a boolean, or the string to be matched.",
       "matcher" : "NOT_MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "EXACT_MATCH"
    }
],
...

为了说明 JSONpath 字符串匹配测试的运作方式，请考虑以下 JSON 响应数据：

{
    "name": "Sample Uptime Check",
    "type": "JSONpath",
    "content": [
        {
            "id": 1,
            "phone": "1234567890",
            "alias": "Exact",
            "enabled": true,
        },
        {
            "id": 2,
            "phone": "1234512345",
            "alias": "Regex",
            "enabled": false,
        }
    ]
}

下表显示了上一个响应中的拨测状态，但针对的是不同的路径、测试值和测试类型：

		拨测状态
JSONpath	测试值	JSONpath 匹配	JSONpath 不匹配
`$.type`	`"JSONpath"`	通过	未通过
`$.name`	`"Sample"`	未通过	通过
`$.name`	`"Sample Uptime Check"`	通过	未通过
`$.content[0].id`	`1`	通过	未通过
`$.content[0].alias`	`"Exact"`	通过	未通过
`$.content[0].enabled`	`true`	通过	未通过

在上表中，JSONpath 列标识要测试的元素，测试值列中列出了相应的值。接下来的两列分别指定了测试类型和拨测结果。

将 JSONpath 与正则表达式进行比较

正则表达式匹配支持与字符串、数字、布尔值和 null JSON 值匹配。

Google Cloud 控制台

如需配置拨测，使其在响应数据中的特定 JSONpath 与某个正则表达式匹配时通过，请使用以下设置：

在响应内容匹配类型菜单中选择与 JSONPath 中的内容匹配。
在 JSONPath 字段中输入路径。
在响应内容字段中输入相应的正则表达式。
如需验证配置，请点击测试。

如需配置拨测，使其在响应数据中的特定 JSONpath 与某个正则表达式匹配时失败，请使用以下设置：

在响应内容匹配类型菜单中选择与 JSONPath 中的内容不匹配。
在 JSONPath 字段中输入路径。
在响应内容字段中输入相应的正则表达式。
如需验证配置，请点击测试。

Cloud Monitoring API

如需配置拨测，使其在 JSON 格式的响应中的特定字段与某个正则表达式匹配时通过，请为 ContentMatcher 对象使用以下值：

...
"contentMatchers": [
    {
       "content" : "Set to the regular expression to be matched."
       "matcher" : "MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "REGEX_MATCH"
    }
],
...

如需配置拨测，使其在 JSON 格式的响应中的特定字段与某个正则表达式匹配时失败，请为 ContentMatcher 对象使用以下值：

...
"contentMatchers": [
    {
       "content" : "Set to the regular expression to be matched.",
       "matcher" : "NOT_MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "REGEX_MATCH"
    }
],
...

为了说明 JSONpath 正则表达式测试的运作方式，请考虑以下 JSON 响应数据：

{
    "name": "Sample Uptime Check",
    "type": "JSONpath",
    "content": [
        {
            "id": 1,
            "phone": "1234567890",
            "alias": "Exact",
            "enabled": true,
        },
        {
            "id": 2,
            "phone": "1234512345",
            "alias": "Regex",
            "enabled": false,
        }
    ]
}

下表显示了上一个响应中的拨测状态，但针对的是不同的路径、正则表达式和测试类型：

		拨测状态
JSONpath	正则表达式	JSONpath 与正则表达式匹配	JSONpath 与正则表达式不匹配
`$.type`	`[A-Z]{4}Path`	通过	未通过
`$.name`	`Sample`	未通过	通过
`$.name`	`.Sample.`	通过	未通过
`$.content[1].id`	`2`	通过	未通过
`$.content[1].phone`	`"[12345]{2}"`	通过	未通过
`$.content[1].enabled`	`f.*`	通过	未通过

在上表中，JSONpath 列标识要测试的元素，正则表达式列中列出了相应的正则表达式。接下来的两列分别指定了测试类型和拨测结果。

验证响应数据 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

如何验证响应数据

Google Cloud 控制台

Cloud Monitoring API

用于验证响应数据的选项

搜索字面量子字符串

Google Cloud 控制台

Cloud Monitoring API

使用正则表达式进行搜索

Google Cloud 控制台

Cloud Monitoring API

在 JSON 响应中搜索特定字段

将 JSONpath 与数字或字符串字面量进行比较

Google Cloud 控制台

Cloud Monitoring API

将 JSONpath 与正则表达式进行比较

Google Cloud 控制台

Cloud Monitoring API

后续步骤

验证响应数据