REST Resource: anomalies

资源：Anomaly

表示在数据集内检测到的异常值。

我们的异常值检测系统会标记出超出历史数据且根据历史数据得出的预期范围内的数据点。虽然这些预期范围有上限和下限，但只有在数据出现异常差时，我们才会标记出异常值（通常与指标超过上限的情况相对应）。

时间轴超出预期范围的多个连续数据点将划分为一个异常值。因此，异常值实际上代表了指标时间轴的一个细分。timelineSpec、dimensions 和 metric 中存储的信息可用于提取扩展时间轴作为上下文的完整时间轴。

所需权限：要访问此资源，发起调用的用户必须对相应应用拥有查看应用信息（只读）权限。

JSON 表示法 
{
  "name": string,
  "metricSet": string,
  "timelineSpec": {
    object (TimelineSpec)
  },
  "dimensions": [
    {
      object (DimensionValue)
    }
  ],
  "metric": {
    object (MetricValue)
  }
}
字段
name

string

异常值的名称。

格式：apps/{app}/anomalies/{anomaly}
metricSet

string

检测到异常值的指标集资源。
timelineSpec

object (TimelineSpec)

涵盖异常情况的时间轴规范。
dimensions[]

object (DimensionValue)

检测到异常值的维度组合。
metric

object (MetricValue)

检测到异常值的指标以及异常值。

时间轴规范

时间轴的时间相关聚合参数的规范。

时间轴有一个汇总时间段（DAILY、HOURLY 等），用于定义指标的汇总方式。

时间轴中的点由汇总时间段的起始 UTC 定义。该时长在 AggregationPeriod 中隐含。

如果指标集支持每小时汇总时段，则始终以世界协调时间 (UTC) 指定，以免因夏令时转换而产生歧义：采用夏令时时，系统会跳过 1 小时；放弃夏令时时重复一个小时。例如，时间戳“2021-11-07 01:00:00 美国/洛杉矶”不明确，因为它可能对应“2021-11-07 08:00:00 世界协调时间 (UTC)”或“2021-11-07 09:00:00 世界协调时间 (UTC)”。

每日汇总期间需要指定一个时区，该时区将确定开始和结束时段的确切时刻。并非所有指标集都支持所有时区，因此请务必检查您要查询的指标集支持哪些时区。

JSON 表示法 
{
  "aggregationPeriod": enum (AggregationPeriod),
  "startTime": {
    object (DateTime)
  },
  "endTime": {
    object (DateTime)
  }
}
字段
aggregationPeriod

enum (AggregationPeriod)

时间轴中数据点的汇总时间段类型。

间隔根据间隔开始的日期和时间进行标识。
startTime

object (DateTime)

时间轴的起始数据点（含边界值）。必须与汇总期一致，如下所示：

  • 每小时：必须设置“分钟”、“秒”和“纳米”字段。时区可以取消设置（默认为世界协调时间 (UTC)），也可以明确设置为“世界协调时间 (UTC)”。设置任何其他 utcOffset 或时区 ID 将导致验证错误。
  • DAILY：必须设置“hours”、“minutes”、“seconds”和“nanos”字段。不同的指标集支持不同的时区。可以将其设置为未设置，以使用指标集指定的默认时区。

终点的时区必须与起点的时区一致。
endTime

object (DateTime)

时间轴的结束数据点（不含此值）。如需了解限制，请参阅 startTime。终点的时区必须与起点的时区一致。

DimensionValue

表示单个维度的值。

JSON 表示法 
{
  "dimension": string,
  "valueLabel": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "int64Value": string
  // End of list of possible types for union field value.
}
字段
dimension

string

维度的名称。
valueLabel

string

（可选）简单易懂的值标签，一律用英文表示。例如，对于西班牙国家/地区代码，应使用“西班牙”。

维度值虽然稳定，但此值标签可能会发生变化。不要假设 (value, valueLabel) 关系是稳定的。例如，ISO 国家/地区代码“MK”最近已改名为“北马其顿”。
联合字段 value。维度的实际值。取决于类型。value 只能是下列其中一项：
stringValue

string

实际值，以字符串表示。
int64Value

string (int64 format)

实际值，以 int64 表示。

MetricValue

表示指标的值。

JSON 表示法 
{
  "metric": string,

  // Union field value can be only one of the following:
  "decimalValue": {
    object (Decimal)
  }
  // End of list of possible types for union field value.

  // Union field confidence_interval can be only one of the following:
  "decimalValueConfidenceInterval": {
    object (DecimalConfidenceInterval)
  }
  // End of list of possible types for union field confidence_interval.
}
字段
metric

string

指标的名称。
联合字段 value。指标的实际值。取决于类型。value 只能是下列其中一项：
decimalValue

object (Decimal)

实际值，以十进制数字表示。
联合字段 confidence_interval。如果指定，表示值的置信区间。confidence_interval 只能是下列其中一项：
decimalValueConfidenceInterval

object (DecimalConfidenceInterval)

type.Decimal 类型的值的置信区间。

小数置信度

表示指标的置信区间。

JSON 表示法 
{
  "lowerBound": {
    object (Decimal)
  },
  "upperBound": {
    object (Decimal)
  }
}
字段
lowerBound

object (Decimal)

置信区间的下限。
upperBound

object (Decimal)

置信区间的上限。

方法

list

 列出任何数据集中的异常。