QueryConfigUnified

更新时间:
复制 MD 格式

名称

类型

描述

示例值

object

查询配置聚合(PROMETHEUS_SINGLE_QUERY / UMODEL_METRICSET_QUERY / UMODEL_LOGSET_QUERY / APM_MULTI_QUERY / CLOUD_MONITORING_QUERY / UMODEL_METRICSET_MULTI_QUERY / PROMETHEUS_MULTI_QUERY / PROMETHEUS_PREDEFINED_METRIC_QUERY / PROMETHEUS_METRIC_GROUP_QUERY [已废弃] / SLS_MULTI_QUERY / UNKNOWN_QUERY)

type

string

查询类型。合法枚举与配套字段:PROMETHEUS_SINGLE_QUERY(必填 expr;可选 enableDataCompleteCheck);PROMETHEUS_PREDEFINED_METRIC_QUERY(必填 metricGroupId、metricId;可选 paramValues、filterValues、enableDataCompleteCheck);PROMETHEUS_METRIC_GROUP_QUERY([已废弃] 必填 metricGroupId、metricIds;可选 paramValues、filterValues、enableDataCompleteCheck;写路径会返回 400);UMODEL_METRICSET_QUERY(必填 metricSet、metric、windowSecs、aggregate;可选 expr、entityDomain/entityType/entityFilters、labelFilters、entityFields、offsetSecs);UMODEL_METRICSET_MULTI_QUERY(必填 queries[*];可选 entityDomain/entityType/entityFilters、windowSecs、offsetSecs、aggregate);UMODEL_LOGSET_QUERY(必填 logSet、expr、windowSecs、aggregate;可选 entityDomain/entityType/entityFilters、labelFilters、offsetSecs);APM_MULTI_QUERY(必填 serviceIdList、measureList;可选 filterList、measureGroupKey);CLOUD_MONITORING_QUERY(必填 namespace、metric、relationType;relationType=INSTANCE 时必填 dimensions,relationType=GROUP 时必填 groupId,relationType=USER 时二者留空);UNKNOWN_QUERY(只读兜底,写路径请勿使用)。禁止使用非枚举值(如 CMS_BASIC_QUERY/SLS_QUERY),后端会返回 Invalidtype 400

expr

string

查询表达式 / SPL 语句。type=PROMETHEUS_SINGLE_QUERY 时推荐填写;type=UMODEL_METRICSET_QUERY 时可选,用于自定义 SPL;type=UMODEL_LOGSET_QUERY 时必填,必须提供 SPL 查询语句(业务层会执行必填校验)

promQl

string

[已废弃] 旧版 Prometheus 查询语句字段,请改用 expr;本字段为兼容保留,后端会自动归一为 expr

enableDataCompleteCheck

boolean

是否启用数据完整性检查(type=PROMETHEUS_SINGLE_QUERY / PROMETHEUS_MULTI_QUERY / PROMETHEUS_PREDEFINED_METRIC_QUERY / PROMETHEUS_METRIC_GROUP_QUERY [已废弃] 时使用)

metricGroupId

string

指标分组 ID(type=PROMETHEUS_PREDEFINED_METRIC_QUERY / PROMETHEUS_METRIC_GROUP_QUERY [已废弃])

metricId

string

预置指标 ID(type=PROMETHEUS_PREDEFINED_METRIC_QUERY)

metricIds

array

[已废弃] 预置指标 ID 列表(原 type=PROMETHEUS_METRIC_GROUP_QUERY 使用);该查询类型已废弃,写路径会返回 400

string

paramValues

array

预置指标参数值列表(type=PROMETHEUS_PREDEFINED_METRIC_QUERY / PROMETHEUS_METRIC_GROUP_QUERY [已废弃])

PrometheusMetricParamValue

filterValues

array

预置指标过滤值列表(type=PROMETHEUS_PREDEFINED_METRIC_QUERY / PROMETHEUS_METRIC_GROUP_QUERY [已废弃])

PrometheusMetricFilterValue

metricSet

string

指标集名称(type=UMODEL_METRICSET_QUERY)

metric

string

指标名称(type=UMODEL_METRICSET_QUERY 必填;type=CLOUD_MONITORING_QUERY 必填,需与 namespace 组合唯一定位云监控指标)

logSet

string

日志集名称(type=UMODEL_LOGSET_QUERY)

windowSecs

integer

聚合时间窗口(秒),type=UMODEL_METRICSET_QUERY / UMODEL_LOGSET_QUERY 时使用;有效范围 [60, 86400]

offsetSecs

integer

查询时间偏移(秒),type=UMODEL_METRICSET_QUERY / UMODEL_LOGSET_QUERY 时使用;与 windowSecs 配合实现 [T - windowSecs - offsetSecs, T - offsetSecs] 的偏移查询;有效范围 [0, 86400]

aggregate

string

聚合函数,type=UMODEL_METRICSET_QUERY / UMODEL_LOGSET_QUERY 时使用

entityDomain

string

实体所属域(type=UMODEL_METRICSET_QUERY / UMODEL_METRICSET_MULTI_QUERY / UMODEL_LOGSET_QUERY 使用;配合 entityType/entityFilters 定位 UModel 实体)

entityType

string

实体类型(type=UMODEL_METRICSET_QUERY / UMODEL_METRICSET_MULTI_QUERY / UMODEL_LOGSET_QUERY 使用)

namespace

string

云监控 namespace(云产品名,type=CLOUD_MONITORING_QUERY)

relationType

string

资源关联类型(type=CLOUD_MONITORING_QUERY)

groupId

string

资源分组 ID(type=CLOUD_MONITORING_QUERY,relationType=GROUP 时使用)

durationSecs

integer

持续时间(秒),type=PROMETHEUS_MULTI_QUERY 时使用

checkAfterDataComplete

boolean

[已废弃] 是否数据完整后再执行告警检测(原 type=PROMETHEUS_MULTI_QUERY 时使用);与 enableDataCompleteCheck 重复,写路径使用此字段会返回 400

joinings

array

Join 列表(type=SLS_MULTI_QUERY 时使用,最多 2 个:joinings[0] 对应查询 0 与查询 1 之间的集合操作,joinings[1] 对应查询 1 与查询 2 之间的集合操作)

Joinings

groupType

string

分组策略(type=SLS_MULTI_QUERY 时使用):none / label / custom

legacyType

string

当 type=UNKNOWN_QUERY 时返回,用于标识本规则当前不可在新 API 上编辑;请提服务工单联系云监控产品团队

legacyRaw

string

当 type=UNKNOWN_QUERY 且为读路径解析失败兜底时返回的原始 V1 query JSON 字符串(含触发失败的字段值,例如 filter.operator=ABC)。前端见此字段非空时仅做只读展示。

queries

array

子查询列表(按 type 多态):SLS_MULTI_QUERY 时每个条目为 SlsNamedQueryEntry(timeUnit/start/end/window/expr);PROMETHEUS_MULTI_QUERY 时每个条目为 PrometheusNamedQueryEntry(name/expr);UMODEL_METRICSET_MULTI_QUERY 时每个条目为 MetricSetNamedQueryEntry

Queries

entityFilters

array

实体过滤列表(type=UMODEL_METRICSET_QUERY / UMODEL_METRICSET_MULTI_QUERY / UMODEL_LOGSET_QUERY 使用)

EntityFilters

labelFilters

array

标签过滤条件(type=UMODEL_METRICSET_QUERY 使用;UMODEL_METRICSET_MULTI_QUERY 请把 labelFilters 平铺到各 queries[*] 中)

LabelFilters

entityFields

array

需要附带返回的实体字段(type=UMODEL_METRICSET_QUERY / UMODEL_METRICSET_MULTI_QUERY / UMODEL_LOGSET_QUERY 使用)

EntityFields

serviceIdList

array

服务 ID 列表(type=APM_MULTI_QUERY)

string

filterList

array

APM 过滤条件列表

FilterList

measureList

array

APM 度量配置列表

MeasureList

measureGroupKey

string

度量分组键(type=APM_MULTI_QUERY 可选,对应 V1 alertMetricInput.groupKey)

dimensions

array

维度列表(type=CLOUD_MONITORING_QUERY,每个 dimension 是 key/value 字符串映射)

object

string

groupFieldList

array

分组字段列表(type=SLS_MULTI_QUERY 且 groupType=custom 时使用)

string