Method: projects.locations.requirements.checkRequirement

检查特定要求。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
location

string

必需。位置的完整资源名称。格式 projects/{project_number_or_id}/locations/{location}

请求正文

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

JSON 表示法 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
字段
requirementType

string

用于指定要检查的要求的类型。支持的类型包括：

  • discoveryengine.googleapis.com/media_recs/general/all/warning
  • discoveryengine.googleapis.com/media_recs/oyml/cvr/warning
  • discoveryengine.googleapis.com/media_recs/rfy/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mlt/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mp/cvr/warning
  • discoveryengine.googleapis.com/media_recs/oyml/wdps/warning
  • discoveryengine.googleapis.com/media_recs/rfy/wdps/warning
  • discoveryengine.googleapis.com/media_recs/mlt/wdps/warning
resources[]

object (MonitoredResource)

要检查此要求的资源。受监控资源所需的类型：

  • discoveryengine.googleapis.com/Branch。

    • 此资源所需的标签：
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • 此资源所需的标签：
      • project_number
      • location_id
      • collection_id
      • datastore_id

响应正文

对 requirements.checkRequirement 方法的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "requirement": {
    object (Requirement)
  },
  "requirementCondition": {
    object (Expr)
  },
  "metricResults": [
    {
      object (MetricQueryResult)
    }
  ],
  "oldestMetricTimestamp": string,
  "result": string
}
字段
requirement

object (Requirement)

要求定义。
requirementCondition

object (Expr)

用于评估要求结果的条件。
metricResults[]

object (MetricQueryResult)

指标结果。
oldestMetricTimestamp

string (Timestamp format)

最早的计算指标（即最新鲜的指标）的时间戳。表示 result 可能无法准确反映在此时间之后执行的任何活动和商品目录更新。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
result

string

要求的结果。它应该是要求定义中的 severity 字段之一。如果在评估期间发生任何错误，则会返回 UNKNOWN。

授权范围

需要以下 OAuth 范围之一：

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

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

要求

数据要求。

JSON 表示法 
{
  "type": string,
  "displayName": string,
  "description": string,
  "condition": {
    object (Expr)
  },
  "metricBindings": [
    {
      object (MetricBinding)
    }
  ],
  "thresholdBindings": [
    {
      object (ThresholdBinding)
    }
  ],
  "violationSamplesBindings": [
    {
      object (ViolationSamplesBinding)
    }
  ],
  "severity": [
    string
  ]
}
字段
type

string

用作标识符的要求类型。必须是唯一的。

类型应以服务名称为前缀，以避免可能发生的冲突。建议对类似要求使用自然的分层分组。

示例：

  • library.googleapis.com/books/min_available_books
  • discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate
displayName

string

要求的名称。
description

string

要求的说明。
condition

object (Expr)

用于评估要求结果的条件。

表达式中的变量应通过 metrics_bindings 或 thresholdBindings 提供。其中，metrics_bindings 用于计算指标，thresholdBindings 用于为相应的 metricBindings 定义阈值。
metricBindings[]

object (MetricBinding)

要在 condition 中使用的指标绑定的列表。
thresholdBindings[]

object (ThresholdBinding)

要在 condition 中使用的阈值绑定列表。
violationSamplesBindings[]

object (ViolationSamplesBinding)

要在 condition 中使用的指标绑定的列表。
severity[]

string

如果不满足要求，则错误的严重程度。必须按从最严格到最不严格的顺序排列。示例：

  • BLOCKING
  • CRITICAL
  • WARNING

要求中的所有阈值都必须具有此处的所有严重程度。

MetricBinding

指定一个指标查询，并将其结果绑定到一个将在 condition 中使用的变量。

JSON 表示法 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
字段
variableId

string

要在 condition 中引用的变量 ID。
resourceType

string

正在针对相应指标进行监控的资源。
metricFilter

string

用于指标查询的过滤字符串。

示例：

"metric.type = "discoveryengine.googleapis.com/events/day_count" AND " "metric.conditions.time_range = "NINETY_DAYS""
description

string

相应指标过滤条件的人类可读说明。
category

string

指标的目标资源的类别。示例：“活动”

ThresholdBinding

指定要应用于 condition CEL 表达式中 metricBindings 的多级阈值。

JSON 表示法 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
字段
variableId

string

要在 condition 中引用的变量 ID。在所有 metricBindings 和 thresholdBindings 中必须是唯一的。
description

string

相应阈值和子要求的直观易懂的说明。
thresholdValues[]

object (ThresholdValue)

阈值的值。这些值应按从最严格到最不严格的顺序排列。

ThresholdValue

为给定的严重程度指定阈值。

JSON 表示法 
{
  "severity": string,
  "value": number
}
字段
severity

string

未达到阈值时的错误严重程度。它应该是要求中的 severity 字段之一。
value

number

阈值。

ViolationSamplesBinding

指定一个样本查询，并将其结果绑定到一个将在 condition 中使用的变量。

JSON 表示法 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
字段
variableId

string

要在 condition 中引用的变量 ID。
sampleFilter

string

用于样本查询的过滤条件字符串。

示例："sample.type = "retail.googleapis.com/userEvent" AND " "sample.labels.event_type = "PURCHASE" "
description

string

相应绑定示例的说明。供界面用于为每个要求条件呈现用户友好的说明。

长度应少于 128 个字符。

MetricQueryResult

指标结果。指标位于 requirementCondition 中。

JSON 表示法 
{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}
字段
name

string

此指标查询名称映射到 requirementCondition 中的变量。
value

object (TypedValue)

指标查询的值。
timestamp

string (Timestamp format)

计算相应指标值的时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
unit

string

报告相应指标时所用的单位。关注者

统一的度量单位代码标准。
metricType

string

与相应查询结果对应的指标的类型标识符。