有奖捉虫:云通信与企业服务文档专题,速来> HOT

AlarmConditionFilter

策略过滤条件

被如下接口引用:DescribeAlarmPolicies, DescribeAlarmPolicy。

名称 类型 描述
Type String 类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
Expression String 表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
Dimensions String 过滤条件
注意:此字段可能返回 null,表示取不到有效值。
示例值:""

AlarmEvent

告警事件

被如下接口引用:DescribeAlarmEvents。

名称 类型 描述
EventName String 事件名
Description String 展示的事件名
Namespace String 告警策略类型

AlarmGroupByItem

聚合条件

被如下接口引用:DescribeAlarmPolicies, DescribeAlarmPolicy。

名称 类型 描述
Id String Item Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:""

AlarmHierarchicalNotice

通知模板ID及通知等级列表,["Remind","Serious"]表示该通知模板仅接收提醒和严重类别的告警

被如下接口引用:CreateAlarmPolicy, ModifyAlarmPolicyNotice。

名称 类型 必选 描述
NoticeId String 通知模板ID
注意:此字段可能返回 null,表示取不到有效值。
Classification Array of String 通知等级列表,["Remind","Serious"]表示该通知模板仅接收提醒和严重类别的告警
注意:此字段可能返回 null,表示取不到有效值。
示例值:["Remind","Serious"]
PolicyId String 模板对应的策略id
注意:此字段可能返回 null,表示取不到有效值。
示例值:policy-iiiss

AlarmHierarchicalValue

告警分级阈值配置

被如下接口引用:CreateAlarmPolicy, ModifyAlarmPolicyCondition。

名称 类型 必选 描述
Remind String 提醒等级阈值
注意:此字段可能返回 null,表示取不到有效值。
Warn String 警告等级阈值
注意:此字段可能返回 null,表示取不到有效值。
Serious String 严重等级阈值
注意:此字段可能返回 null,表示取不到有效值。

AlarmHistory

告警历史数据

被如下接口引用:DescribeAlarmHistories。

名称 类型 描述
AlarmId String 告警历史Id
示例值:01e1f33f-b4ec-43db-8fd0-6f7e163e6ca5
MonitorType String 监控类型
示例值:MT_QCE
Namespace String 策略类型
示例值:cvm_device
AlarmObject String 告警对象
示例值:ins-abcdef
Content String 告警内容
示例值:CPU 使用率 > 80%
FirstOccurTime Integer 时间戳,首次出现时间
示例值:1611700000
LastOccurTime Integer 时间戳,最后出现时间
示例值:1611734567
AlarmStatus String 告警状态,ALARM=未恢复 OK=已恢复 NO_CONF=已失效 NO_DATA=数据不足
示例值:ALARM
PolicyId String 告警策略 Id
示例值:policy-abcdef
PolicyName String 策略名称
示例值:云服务器告警策略
VPC String 基础产品告警的告警对象所属网络
示例值:0
ProjectId Integer 项目 Id
示例值:0
ProjectName String 项目名字
示例值:默认项目
InstanceGroup Array of InstanceGroups 告警对象所属实例组
ReceiverUids Array of Integer 接收人列表
ReceiverGroups Array of Integer 接收组列表
NoticeWays Array of String 告警渠道列表 SMS=短信 EMAIL=邮件 CALL=电话 WECHAT=微信
OriginId String 可用于实例、实例组的绑定和解绑接口(BindingPolicyObjectUnBindingAllPolicyObjectUnBindingPolicyObject)的策略 ID
示例值:12345
AlarmType String 告警类型
示例值:METRIC
EventId Integer 事件Id
示例值:0
Region String 地域
示例值:ap-guangzhou
PolicyExists Integer 策略是否存在 0=不存在 1=存在
示例值:1
MetricsInfo Array of AlarmHistoryMetric 指标信息
注意:此字段可能返回 null,表示取不到有效值。
Dimensions String 告警实例的维度信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"cluster_name":"es-dnxsssss"}
AlarmLevel String 告警等级
注意:此字段可能返回 null,表示取不到有效值。
示例值:Warn
ShieldFlag Integer 是否有配置告警屏蔽规则
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AlarmShieldingType String 屏蔽类型(英文)
注意:此字段可能返回 null,表示取不到有效值。
示例值:FOREVER_SHIELD
AlarmShieldingTime String 屏蔽时间(英文)
注意:此字段可能返回 null,表示取不到有效值。
示例值:Permanent
AlarmShieldingShowType String 屏蔽类型(中文)
注意:此字段可能返回 null,表示取不到有效值。
示例值:时间范围屏蔽
AlarmShieldingShowTime String 屏蔽时间(中文)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023/01/01 12:00:00-2023/01/02 12:00:00
AlarmShieldReason String 屏蔽原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试
InternalDimensions String 告警实例的维度信息
注意:此字段可能返回 null,表示取不到有效值。
MetricName String 指标名称
注意:此字段可能返回 null,表示取不到有效值。

AlarmHistoryMetric

告警历史的指标信息

被如下接口引用:DescribeAlarmHistories。

名称 类型 描述
QceNamespace String 云产品监控类型查询数据使用的命名空间
示例值:qce/cvm
MetricName String 指标名
示例值:CpuUsage
Period Integer 统计周期
示例值:60
Value String 触发告警的数值
示例值:10
Description String 指标的展示名
示例值:CPU使用率

AlarmNotice

告警通知模板详情

被如下接口引用:DescribeAlarmNotice, DescribeAlarmNotices, DescribeAlarmPolicies, DescribeAlarmPolicy。

名称 类型 描述
Id String 告警通知模板 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:12345
Name String 告警通知模板名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:默认通知
UpdatedAt String 上次修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2020-11-16 13:56:56
UpdatedBy String 上次修改人
注意:此字段可能返回 null,表示取不到有效值。
示例值:1500000688
NoticeType String 告警通知类型 ALARM=未恢复通知 OK=已恢复通知 ALL=全部通知
注意:此字段可能返回 null,表示取不到有效值。
示例值:ALL
UserNotices Array of UserNotice 用户通知列表
注意:此字段可能返回 null,表示取不到有效值。
URLNotices Array of URLNotice 回调通知列表
注意:此字段可能返回 null,表示取不到有效值。
IsPreset Integer 是否是系统预设通知模板 0=否 1=是
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NoticeLanguage String 通知语言 zh-CN=中文 en-US=英文
注意:此字段可能返回 null,表示取不到有效值。
示例值:zh-CN
PolicyIds Array of String 告警通知模板绑定的告警策略ID列表
注意:此字段可能返回 null,表示取不到有效值。
AMPConsumerId String 后台 amp consumer id
注意:此字段可能返回 null,表示取不到有效值。
示例值:Consumer-asfafasf
CLSNotices Array of CLSNotice 推送cls渠道
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tag 通知模板绑定的标签
注意:此字段可能返回 null,表示取不到有效值。

AlarmPolicy

告警策略详情

被如下接口引用:DescribeAlarmPolicies, DescribeAlarmPolicy。

名称 类型 描述
PolicyId String 告警策略 ID
注意:此字段可能返回 null,表示取不到有效值。
PolicyName String 告警策略名称
注意:此字段可能返回 null,表示取不到有效值。
Remark String 备注信息
注意:此字段可能返回 null,表示取不到有效值。
MonitorType String 监控类型 MT_QCE=云产品监控
注意:此字段可能返回 null,表示取不到有效值。
Enable Integer 启停状态 0=停用 1=启用
注意:此字段可能返回 null,表示取不到有效值。
UseSum Integer 策略组绑定的实例数
注意:此字段可能返回 null,表示取不到有效值。
ProjectId Integer 项目 Id -1=无项目 0=默认项目
注意:此字段可能返回 null,表示取不到有效值。
ProjectName String 项目名
注意:此字段可能返回 null,表示取不到有效值。
Namespace String 告警策略类型
注意:此字段可能返回 null,表示取不到有效值。
ConditionTemplateId String 触发条件模板 Id
注意:此字段可能返回 null,表示取不到有效值。
Condition AlarmPolicyCondition 指标触发条件
注意:此字段可能返回 null,表示取不到有效值。
EventCondition AlarmPolicyEventCondition 事件触发条件
注意:此字段可能返回 null,表示取不到有效值。
NoticeIds Array of String 通知规则 id 列表
注意:此字段可能返回 null,表示取不到有效值。
Notices Array of AlarmNotice 通知规则 列表
注意:此字段可能返回 null,表示取不到有效值。
TriggerTasks Array of AlarmPolicyTriggerTask 触发任务列表
注意:此字段可能返回 null,表示取不到有效值。
ConditionsTemp ConditionsTemp 模板策略组
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
LastEditUin String 最后编辑的用户uin
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
InsertTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
Region Array of String 地域
注意:此字段可能返回 null,表示取不到有效值。
NamespaceShowName String namespace显示名字
注意:此字段可能返回 null,表示取不到有效值。
IsDefault Integer 是否默认策略,1是,0否
注意:此字段可能返回 null,表示取不到有效值。
CanSetDefault Integer 能否设置默认策略,1是,0否
注意:此字段可能返回 null,表示取不到有效值。
InstanceGroupId Integer 实例分组ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceSum Integer 实例分组总实例数
注意:此字段可能返回 null,表示取不到有效值。
InstanceGroupName String 实例分组名称
注意:此字段可能返回 null,表示取不到有效值。
RuleType String 触发条件类型 STATIC=静态阈值 DYNAMIC=动态类型
注意:此字段可能返回 null,表示取不到有效值。
OriginId String 用于实例、实例组绑定和解绑接口(BindingPolicyObject、UnBindingAllPolicyObject、UnBindingPolicyObject)的策略 ID
注意:此字段可能返回 null,表示取不到有效值。
TagInstances Array of TagInstance 标签
注意:此字段可能返回 null,表示取不到有效值。
Filter AlarmConditionFilter 过滤条件
注意:此字段可能返回 null,表示取不到有效值。
GroupBy Array of AlarmGroupByItem 聚合条件
注意:此字段可能返回 null,表示取不到有效值。
FilterDimensionsParam String 策略关联的过滤维度信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
IsOneClick Integer 是否为一键告警策略
注意:此字段可能返回 null,表示取不到有效值。
OneClickStatus Integer 一键告警策略是否开启
注意:此字段可能返回 null,表示取不到有效值。
AdvancedMetricNumber Integer 高级指标数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
IsBindAll Integer 策略是否是全部对象策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Tags Array of Tag 策略标签
注意:此字段可能返回 null,表示取不到有效值。
IsSupportAlarmTag Integer 是否支持告警标签
注意:此字段可能返回 null,表示取不到有效值。
TagOperation String 多标签交/并集关系
注意:此字段可能返回 null,表示取不到有效值。

AlarmPolicyCondition

告警策略指标触发条件

被如下接口引用:CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition。

名称 类型 必选 描述
IsUnionRule Integer 告警触发条件的判断方式. 0: 任意; 1: 全部; 2: 复合. 当取值为2的时候为复合告警,与参数 ComplexExpression 配合使用.
注意:此字段可能返回 null,表示取不到有效值。
Rules Array of AlarmPolicyRule 告警触发条件列表
注意:此字段可能返回 null,表示取不到有效值。
ComplexExpression String 复合告警触发条件的判断表达式,当 IsUnionRule 取值为2的时候有效. 其作用是描述多个触发条件需要满足表达式求值为True时才算是满足告警条件.
注意:此字段可能返回 null,表示取不到有效值。
示例值:(1 OR 2) AND (3 OR 4)

AlarmPolicyEventCondition

告警策略事件触发条件

被如下接口引用:CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition。

名称 类型 必选 描述
Rules Array of AlarmPolicyRule 告警触发条件列表
注意:此字段可能返回 null,表示取不到有效值。

AlarmPolicyFilter

告警策略过滤条件

被如下接口引用:CreateAlarmPolicy, ModifyAlarmPolicyCondition。

名称 类型 必选 描述
Type String 过滤条件类型 DIMENSION=使用 Dimensions 做过滤
注意:此字段可能返回 null,表示取不到有效值。
Dimensions String AlarmPolicyDimension 二维数组序列化后的json字符串,一维数组之间互为或关系,一维数组内的元素互为与关系
注意:此字段可能返回 null,表示取不到有效值。

AlarmPolicyRule

告警策略触发条件

被如下接口引用:CreateAlarmPolicy, ModifyAlarmPolicyCondition。

名称 类型 必选 描述
MetricName String 指标名或事件名,支持的指标可以从 DescribeAlarmMetrics 查询,支持的事件可以从 DescribeAlarmEvents 查询 。
注意:此字段可能返回 null,表示取不到有效值。
示例值:CpuUsage
Period Integer 秒数 统计周期,支持的值可以从 DescribeAlarmMetrics 查询。
注意:此字段可能返回 null,表示取不到有效值。
示例值:60
Operator String 英文运算符
intelligent=无阈值智能检测
eq=等于
ge=大于等于
gt=大于
le=小于等于
lt=小于
ne=不等于
day_increase=天同比增长
day_decrease=天同比下降
day_wave=天同比波动
week_increase=周同比增长
week_decrease=周同比下降
week_wave=周同比波动
cycle_increase=环比增长
cycle_decrease=环比下降
cycle_wave=环比波动
re=正则匹配
支持的值可以从 DescribeAlarmMetrics 查询。
注意:此字段可能返回 null,表示取不到有效值。
示例值:gt
Value String 阈值,支持的范围可以从 DescribeAlarmMetrics 查询。
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
ContinuePeriod Integer 周期数 持续通知周期 1=持续1个周期 2=持续2个周期...,支持的值可以从 DescribeAlarmMetrics 查询
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NoticeFrequency Integer 秒数 告警间隔 0=不重复 300=每5分钟告警一次 600=每10分钟告警一次 900=每15分钟告警一次 1800=每30分钟告警一次 3600=每1小时告警一次 7200=每2小时告警一次 10800=每3小时告警一次 21600=每6小时告警一次 43200=每12小时告警一次 86400=每1天告警一次
注意:此字段可能返回 null,表示取不到有效值。
示例值:300
IsPowerNotice Integer 告警频率是否指数增长 0=否 1=是
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Filter AlarmPolicyFilter 对于单个触发规则的过滤条件
注意:此字段可能返回 null,表示取不到有效值。
Description String 指标展示名,用于出参
注意:此字段可能返回 null,表示取不到有效值。
示例值:CPU使用率
Unit String 单位,用于出参
注意:此字段可能返回 null,表示取不到有效值。
示例值:%
RuleType String 触发条件类型 STATIC=静态阈值 DYNAMIC=动态阈值。创建或编辑策略时,如不填则默认为 STATIC。
注意:此字段可能返回 null,表示取不到有效值。
示例值:STATIC
IsAdvanced Integer 是否为高级指标,0否,1是
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
IsOpen Integer 高级指标是否开通,0否,1是
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ProductId String 集成中心产品ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cvm
ValueMax Float 最大值
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ValueMin Float 最小值
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
HierarchicalValue AlarmHierarchicalValue 告警分级阈值配置
注意:此字段可能返回 null,表示取不到有效值。

AlarmPolicyTriggerTask

告警策略触发任务

被如下接口引用:CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyTasks。

名称 类型 必选 描述
Type String 触发任务类型 AS=弹性伸缩
注意:此字段可能返回 null,表示取不到有效值。
TaskConfig String 用 json 表示配置信息 {"Key1":"Value1","Key2":"Value2"}
注意:此字段可能返回 null,表示取不到有效值。

BindingPolicyObjectDimension

策略绑定实例维度信息

被如下接口引用:BindingPolicyObject。

名称 类型 必选 描述
Region String 地域名
示例值:gz
RegionId Integer 地域ID
示例值:1
Dimensions String 实例的维度信息,格式为
{"unInstanceId":"ins-00jvv9mo"}。不同云产品的维度信息不同,详见
指标维度信息Dimensions列表
示例值:{"unInstanceId":"ins-00jvv9mo"}
EventDimensions String 事件维度信息
示例值:{"uuid":"c734cd0d-d050-44bd-8d17-f6381039b4b6"}

CLSNotice

告警通知中的推送CLS操作

被如下接口引用:CreateAlarmNotice, DescribeAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice。

名称 类型 必选 描述
Region String 地域
示例值:ap-guangzhou
LogSetId String 日志集Id
示例值:logset-28hg48g2
TopicId String 主题Id
示例值:topic-2ingu2bg
Enable Integer 启停状态,可不传,默认启用。0=停用,1=启用
示例值:1

CommonNamespace

统一的命名空间信息

被如下接口引用:DescribeAllNamespaces。

名称 类型 描述
Id String 命名空间标示
Name String 命名空间名称
Value String 命名空间值
ProductName String 产品名称
Config String 配置信息
AvailableRegions Array of String 支持地域列表
SortId Integer 排序Id
DashboardId String Dashboard中的唯一表示

CommonNamespaceNew

策略类型信息

被如下接口引用:DescribeAllNamespaces。

名称 类型 描述
Id String 命名空间标示
示例值:performance_database_metric
Name String 命名空间名称
示例值:数据库指标
MonitorType String 监控类型
示例值: MT_TAW
Dimensions Array of DimensionNew 维度信息

Condition

告警条件

被如下接口引用:DescribeConditionsTemplateList。

名称 类型 描述
AlarmNotifyPeriod Integer 告警通知频率
示例值:7200
AlarmNotifyType Integer 重复通知策略预定义(0 - 只告警一次, 1 - 指数告警,2 - 连接告警)
示例值:0
CalcType String 检测方式
注意:此字段可能返回 null,表示取不到有效值。
示例值:"1"
CalcValue String 检测值
注意:此字段可能返回 null,表示取不到有效值。
示例值:"95"
ContinueTime String 持续时间,单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:"300"
MetricID Integer 指标ID
示例值:33
MetricDisplayName String 指标展示名称(对外)
示例值:"CPU利用率"
Period Integer 周期
示例值:60
RuleID Integer 规则ID
示例值:623123
Unit String 指标单位
示例值:"%"
IsAdvanced Integer 是否为高级指标,0:否;1:是
示例值:0
IsOpen Integer 是否开通高级指标,0:否;1:是
示例值:0
ProductId String 产品ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:""

ConditionsTemp

告警条件模板

被如下接口引用:DescribeAlarmPolicies, DescribeAlarmPolicy。

名称 类型 描述
TemplateName String 模板名称
注意:此字段可能返回 null,表示取不到有效值。
Condition AlarmPolicyCondition 指标触发条件
注意:此字段可能返回 null,表示取不到有效值。
EventCondition AlarmPolicyEventCondition 事件触发条件
注意:此字段可能返回 null,表示取不到有效值。

CreatePolicyGroupCondition

创建策略传入的阈值告警条件

被如下接口引用:CreatePolicyGroup。

名称 类型 必选 描述
MetricId Integer 指标Id
AlarmNotifyType Integer 告警发送收敛类型。0连续告警,1指数告警
AlarmNotifyPeriod Integer 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次
CalcType Integer 比较类型,1表示大于,2表示大于等于,3表示小于,4表示小于等于,5表示相等,6表示不相等。如果指标有配置默认比较类型值可以不填。
CalcValue Float 比较的值,如果指标不必须CalcValue可不填
CalcPeriod Integer 数据聚合周期(单位秒),若指标有默认值可不填
ContinuePeriod Integer 持续几个检测周期触发规则会告警
RuleId Integer 如果通过模板创建,需要传入模板中该指标的对应RuleId

CreatePolicyGroupEventCondition

创建策略传入的事件告警条件

被如下接口引用:CreatePolicyGroup。

名称 类型 必选 描述
EventId Integer 告警事件的Id
AlarmNotifyType Integer 告警发送收敛类型。0连续告警,1指数告警
AlarmNotifyPeriod Integer 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次
RuleId Integer 如果通过模板创建,需要传入模板中该指标的对应RuleId

DataPoint

监控数据点

被如下接口引用:GetMonitorData。

名称 类型 描述
Dimensions Array of Dimension 实例对象维度组合
Timestamps Array of Float 时间戳数组,表示那些时间点有数据,缺失的时间戳,没有数据点,可以理解为掉点了
Values Array of Float 监控值数组,该数组和Timestamps一一对应
MaxValues Array of Float 监控值数组,该数组和Timestamps一一对应
注意:此字段可能返回 null,表示取不到有效值。
MinValues Array of Float 监控值数组,该数组和Timestamps一一对应
注意:此字段可能返回 null,表示取不到有效值。
AvgValues Array of Float 监控值数组,该数组和Timestamps一一对应
注意:此字段可能返回 null,表示取不到有效值。

DescribeAccidentEventListAlarms

DescribeAccidentEventList接口的出参类型

被如下接口引用:DescribeAccidentEventList。

名称 类型 描述
BusinessTypeDesc String 事件分类
注意:此字段可能返回 null,表示取不到有效值。
AccidentTypeDesc String 事件类型
注意:此字段可能返回 null,表示取不到有效值。
BusinessID Integer 事件分类的ID,1表示服务问题,2表示其他订阅
注意:此字段可能返回 null,表示取不到有效值。
EventStatus Integer 事件状态的ID,0表示已恢复,1表示未恢复
注意:此字段可能返回 null,表示取不到有效值。
AffectResource String 影响的对象
注意:此字段可能返回 null,表示取不到有效值。
Region String 事件的地域
注意:此字段可能返回 null,表示取不到有效值。
OccurTime String 事件发生的时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。

DescribeBasicAlarmListAlarms

DescribeBasicAlarmList返回的Alarms

被如下接口引用:DescribeBasicAlarmList。

名称 类型 描述
Id Integer 该条告警的ID
ProjectId Integer 项目ID
注意:此字段可能返回 null,表示取不到有效值。
ProjectName String 项目名称
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 告警状态ID,0表示未恢复;1表示已恢复;2,3,5表示数据不足;4表示已失效
注意:此字段可能返回 null,表示取不到有效值。
AlarmStatus String 告警状态,ALARM表示未恢复;OK表示已恢复;NO_DATA表示数据不足;NO_CONF表示已失效
注意:此字段可能返回 null,表示取不到有效值。
GroupId Integer 策略组ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 策略组名
注意:此字段可能返回 null,表示取不到有效值。
FirstOccurTime String 发生时间
注意:此字段可能返回 null,表示取不到有效值。
Duration Integer 持续时间,单位s
注意:此字段可能返回 null,表示取不到有效值。
LastOccurTime String 结束时间
注意:此字段可能返回 null,表示取不到有效值。
Content String 告警内容
注意:此字段可能返回 null,表示取不到有效值。
ObjName String 告警对象
注意:此字段可能返回 null,表示取不到有效值。
ObjId String 告警对象ID
注意:此字段可能返回 null,表示取不到有效值。
ViewName String 策略类型
注意:此字段可能返回 null,表示取不到有效值。
Vpc String VPC,只有CVM有
注意:此字段可能返回 null,表示取不到有效值。
MetricId Integer 指标ID
注意:此字段可能返回 null,表示取不到有效值。
MetricName String 指标名
注意:此字段可能返回 null,表示取不到有效值。
AlarmType Integer 告警类型,0表示指标告警,2表示产品事件告警,3表示平台事件告警
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
Dimensions String 告警对象维度信息
注意:此字段可能返回 null,表示取不到有效值。
NotifyWay Array of String 通知方式
注意:此字段可能返回 null,表示取不到有效值。
InstanceGroup Array of InstanceGroup 所属实例组信息
注意:此字段可能返回 null,表示取不到有效值。

DescribeBindingPolicyObjectListDimension

DescribeBindingPolicyObjectList接口的Dimension

被如下接口引用:DescribeBindingPolicyObjectList。

名称 类型 必选 描述
RegionId Integer 地域id
Region String 地域简称
Dimensions String 维度组合json字符串
EventDimensions String 事件维度组合json字符串

DescribeBindingPolicyObjectListInstance

查询策略绑定对象列表接口返回的对象实例信息

被如下接口引用:DescribeBindingPolicyObjectList。

名称 类型 描述
UniqueId String 对象唯一id
Dimensions String 表示对象实例的维度集合,jsonObj字符串
IsShielded Integer 对象是否被屏蔽,0表示未屏蔽,1表示被屏蔽
Region String 对象所在的地域

DescribeBindingPolicyObjectListInstanceGroup

DescribeBindingPolicyObjectList返回的是实例分组信息

被如下接口引用:DescribeBindingPolicyObjectList。

名称 类型 描述
InstanceGroupId Integer 实例分组id
ViewName String 告警策略类型名称
LastEditUin String 最后编辑uin
GroupName String 实例分组名称
InstanceSum Integer 实例数量
UpdateTime Integer 更新时间
InsertTime Integer 创建时间
Regions Array of String 实例所在的地域集合
注意:此字段可能返回 null,表示取不到有效值。

DescribePolicyConditionListCondition

DescribePolicyConditionList策略条件

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
PolicyViewName String 策略视图名称
EventMetrics Array of DescribePolicyConditionListEventMetric 事件告警条件
注意:此字段可能返回 null,表示取不到有效值。
IsSupportMultiRegion Boolean 是否支持多地域
Metrics Array of DescribePolicyConditionListMetric 指标告警条件
注意:此字段可能返回 null,表示取不到有效值。
Name String 策略类型名称
SortId Integer 排序id
SupportDefault Boolean 是否支持默认策略
SupportRegions Array of String 支持该策略类型的地域列表
注意:此字段可能返回 null,表示取不到有效值。
DeprecatingInfo DescribePolicyConditionListResponseDeprecatingInfo 弃用信息
注意:此字段可能返回 null,表示取不到有效值。

DescribePolicyConditionListConfigManual

DescribePolicyConditionList.ConfigManual

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
CalcType DescribePolicyConditionListConfigManualCalcType 检测方式
注意:此字段可能返回 null,表示取不到有效值。
CalcValue DescribePolicyConditionListConfigManualCalcValue 检测阈值
注意:此字段可能返回 null,表示取不到有效值。
ContinueTime DescribePolicyConditionListConfigManualContinueTime 持续时间
注意:此字段可能返回 null,表示取不到有效值。
Period DescribePolicyConditionListConfigManualPeriod 数据周期
注意:此字段可能返回 null,表示取不到有效值。
PeriodNum DescribePolicyConditionListConfigManualPeriodNum 持续周期个数
注意:此字段可能返回 null,表示取不到有效值。
StatType DescribePolicyConditionListConfigManualStatType 聚合方式
注意:此字段可能返回 null,表示取不到有效值。

DescribePolicyConditionListConfigManualCalcType

DescribePolicyConditionList.ConfigManual.CalcType

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
Keys Array of Integer CalcType 取值
注意:此字段可能返回 null,表示取不到有效值。
Need Boolean 是否必须

DescribePolicyConditionListConfigManualCalcValue

DescribePolicyConditionList.ConfigManual.CalcValue

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
Default String 默认值
注意:此字段可能返回 null,表示取不到有效值。
Fixed String 固定值
注意:此字段可能返回 null,表示取不到有效值。
Max String 最大值
注意:此字段可能返回 null,表示取不到有效值。
Min String 最小值
注意:此字段可能返回 null,表示取不到有效值。
Need Boolean 是否必须

DescribePolicyConditionListConfigManualContinueTime

DescribePolicyConditionList.ConfigManual.ContinueTime

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
Default Integer 默认持续时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
Keys Array of Integer 可选持续时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
Need Boolean 是否必须

DescribePolicyConditionListConfigManualPeriod

DescribePolicyConditionList.ConfigManual.Period

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
Default Integer 默认周期,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
Keys Array of Integer 可选周期,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
Need Boolean 是否必须

DescribePolicyConditionListConfigManualPeriodNum

DescribePolicyConditionList.ConfigManual.PeriodNum

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
Default Integer 默认周期数
注意:此字段可能返回 null,表示取不到有效值。
Keys Array of Integer 可选周期数
注意:此字段可能返回 null,表示取不到有效值。
Need Boolean 是否必须

DescribePolicyConditionListConfigManualStatType

DescribePolicyConditionList.ConfigManual.StatType

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
P5 String 数据聚合方式,周期5秒
注意:此字段可能返回 null,表示取不到有效值。
P10 String 数据聚合方式,周期10秒
注意:此字段可能返回 null,表示取不到有效值。
P60 String 数据聚合方式,周期1分钟
注意:此字段可能返回 null,表示取不到有效值。
P300 String 数据聚合方式,周期5分钟
注意:此字段可能返回 null,表示取不到有效值。
P600 String 数据聚合方式,周期10分钟
注意:此字段可能返回 null,表示取不到有效值。
P1800 String 数据聚合方式,周期30分钟
注意:此字段可能返回 null,表示取不到有效值。
P3600 String 数据聚合方式,周期1小时
注意:此字段可能返回 null,表示取不到有效值。
P86400 String 数据聚合方式,周期1天
注意:此字段可能返回 null,表示取不到有效值。

DescribePolicyConditionListEventMetric

DescribePolicyConditionList.EventMetric

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
EventId Integer 事件id
EventShowName String 事件名称
NeedRecovered Boolean 是否需要恢复
Type Integer 事件类型,预留字段,当前固定取值为2

DescribePolicyConditionListMetric

指标告警配置

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
ConfigManual DescribePolicyConditionListConfigManual 指标配置
注意:此字段可能返回 null,表示取不到有效值。
MetricId Integer 指标id
MetricShowName String 指标名称
MetricUnit String 指标单位

DescribePolicyConditionListResponseDeprecatingInfo

DescribePolicyConditionListResponseDeprecatingInfo

被如下接口引用:DescribePolicyConditionList。

名称 类型 描述
Hidden Boolean 是否隐藏
注意:此字段可能返回 null,表示取不到有效值。
NewViewNames Array of String 新视图名称
注意:此字段可能返回 null,表示取不到有效值。
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。

DescribePolicyGroupInfoCallback

查询策略输出的用户回调信息

被如下接口引用:DescribePolicyGroupInfo。

名称 类型 描述
CallbackUrl String 用户回调接口地址
ValidFlag Integer 用户回调接口状态,0表示未验证,1表示已验证,2表示存在url但没有通过验证
VerifyCode String 用户回调接口验证码

DescribePolicyGroupInfoCondition

查询策略输出的阈值告警条件

被如下接口引用:DescribePolicyGroupInfo, DescribePolicyGroupList。

名称 类型 描述
MetricShowName String 指标名称
Period Integer 数据聚合周期(单位秒)
MetricId Integer 指标id
RuleId Integer 阈值规则id
Unit String 指标单位
AlarmNotifyType Integer 告警发送收敛类型。0连续告警,1指数告警
AlarmNotifyPeriod Integer 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次
CalcType Integer 比较类型,1表示大于,2表示大于等于,3表示小于,4表示小于等于,5表示相等,6表示不相等,7表示日同比上涨,8表示日同比下降,9表示周同比上涨,10表示周同比下降,11表示周期环比上涨,12表示周期环比下降
注意:此字段可能返回 null,表示取不到有效值。
CalcValue String 检测阈值
注意:此字段可能返回 null,表示取不到有效值。
ContinueTime Integer 持续多长时间触发规则会告警(单位秒)
注意:此字段可能返回 null,表示取不到有效值。
MetricName String 告警指标名
注意:此字段可能返回 null,表示取不到有效值。

DescribePolicyGroupInfoConditionTpl

查询策略输出的模板策略组信息

被如下接口引用:DescribePolicyGroupInfo, DescribePolicyGroupList。

名称 类型 描述
GroupId Integer 策略组id
GroupName String 策略组名称
ViewName String 策略类型
Remark String 策略组说明
LastEditUin String 最后编辑的用户uin
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。
InsertTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
IsUnionRule Integer 是否且规则
注意:此字段可能返回 null,表示取不到有效值。

DescribePolicyGroupInfoEventCondition

查询策略输出的事件告警条件

被如下接口引用:DescribePolicyGroupInfo, DescribePolicyGroupList。

名称 类型 描述
EventId Integer 事件id
RuleId Integer 事件告警规则id
EventShowName String 事件名称
AlarmNotifyPeriod Integer 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次
AlarmNotifyType Integer 告警发送收敛类型。0连续告警,1指数告警

DescribePolicyGroupInfoReceiverInfo

查询策略输出的告警接收人信息

被如下接口引用:DescribePolicyGroupInfo, DescribePolicyGroupList。

名称 类型 描述
ReceiverGroupList Array of Integer 告警接收组id列表
示例值: 无
ReceiverUserList Array of Integer 告警接收人id列表
StartTime Integer 告警时间段开始时间。范围[0,86400),作为 UNIX 时间戳转成北京时间后去掉日期,例如7200表示"10:0:0"
EndTime Integer 告警时间段结束时间。含义同StartTime
ReceiverType String 接收类型。“group”(接收组)或“user”(接收人)
NotifyWay Array of String 告警通知方式。可选 "SMS","SITE","EMAIL","CALL","WECHAT"
UidList Array of Integer 电话告警接收者uid
注意:此字段可能返回 null,表示取不到有效值。
RoundNumber Integer 电话告警轮数
RoundInterval Integer 电话告警每轮间隔(秒)
PersonInterval Integer 电话告警对个人间隔(秒)
NeedSendNotice Integer 是否需要电话告警触达提示。0不需要,1需要
SendFor Array of String 电话告警通知时机。可选"OCCUR"(告警时通知),"RECOVER"(恢复时通知)
RecoverNotify Array of String 恢复通知方式。可选"SMS"
ReceiveLanguage String 告警发送语言
注意:此字段可能返回 null,表示取不到有效值。

DescribePolicyGroupListGroup

DescribePolicyGroupList.Group

被如下接口引用:DescribePolicyGroupList。

名称 类型 描述
GroupId Integer 策略组id
GroupName String 策略组名称
IsOpen Boolean 是否开启
ViewName String 策略视图名称
LastEditUin String 最近编辑的用户uin
UpdateTime Integer 最后修改时间
InsertTime Integer 创建时间
UseSum Integer 策略组绑定的实例数
NoShieldedSum Integer 策略组绑定的未屏蔽实例数
IsDefault Integer 是否为默认策略,0表示非默认策略,1表示默认策略
CanSetDefault Boolean 是否可以设置成默认策略
ParentGroupId Integer 父策略组id
Remark String 策略组备注
ProjectId Integer 策略组所属项目id
Conditions Array of DescribePolicyGroupInfoCondition 阈值规则列表
注意:此字段可能返回 null,表示取不到有效值。
EventConditions Array of DescribePolicyGroupInfoEventCondition 产品事件规则列表
注意:此字段可能返回 null,表示取不到有效值。
ReceiverInfos Array of DescribePolicyGroupInfoReceiverInfo 用户接收人列表
注意:此字段可能返回 null,表示取不到有效值。
ConditionsTemp DescribePolicyGroupInfoConditionTpl 模板策略组
注意:此字段可能返回 null,表示取不到有效值。
InstanceGroup DescribePolicyGroupListGroupInstanceGroup 策略组绑定的实例组信息
注意:此字段可能返回 null,表示取不到有效值。
IsUnionRule Integer 且或规则标识, 0表示或规则(任意一条规则满足阈值条件就告警), 1表示且规则(所有规则都满足阈值条件才告警)
注意:此字段可能返回 null,表示取不到有效值。

DescribePolicyGroupListGroupInstanceGroup

DescribePolicyGroupList接口策略组绑定的实例分组信息

被如下接口引用:DescribePolicyGroupList。

名称 类型 描述
InstanceGroupId Integer 实例分组名称id
ViewName String 策略类型视图名称
LastEditUin String 最近编辑的用户uin
GroupName String 实例分组名称
InstanceSum Integer 实例数量
UpdateTime Integer 更新时间
InsertTime Integer 创建时间

DescribeProductEventListDimensions

DescribeProductEventList的入参Dimensions

被如下接口引用:DescribeProductEventList。

名称 类型 必选 描述
Name String 维度名
Value String 维度值

DescribeProductEventListEvents

DescribeProductEventList返回的Events

被如下接口引用:DescribeProductEventList。

名称 类型 描述
EventId Integer 事件ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:111
EventCName String 事件中文名
注意:此字段可能返回 null,表示取不到有效值。
示例值:ping不可达
EventEName String 事件英文名
注意:此字段可能返回 null,表示取不到有效值。
示例值:ping_unreachable
EventName String 事件简称
注意:此字段可能返回 null,表示取不到有效值。
示例值:ping_unreachable
ProductCName String 产品中文名
注意:此字段可能返回 null,表示取不到有效值。
示例值:cvm
ProductEName String 产品英文名
注意:此字段可能返回 null,表示取不到有效值。
示例值:cvm
ProductName String 产品简称
注意:此字段可能返回 null,表示取不到有效值。
示例值:cvm
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:ins-3xdfd90
InstanceName String 实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:ins-3xdfd90
ProjectId String 项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:123
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:gz
Status String 状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SupportAlarm Integer 是否支持告警
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Type String 事件类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:21
StartTime Integer 开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1611560738
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1611560790
Dimensions Array of DescribeProductEventListEventsDimensions 实例对象信息
注意:此字段可能返回 null,表示取不到有效值。
AdditionMsg Array of DescribeProductEventListEventsDimensions 实例对象附加信息
注意:此字段可能返回 null,表示取不到有效值。
IsAlarmConfig Integer 是否配置告警
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
GroupInfo Array of DescribeProductEventListEventsGroupInfo 策略信息
注意:此字段可能返回 null,表示取不到有效值。
ViewName String 显示名称ViewName
注意:此字段可能返回 null,表示取不到有效值。
示例值:cvm/device

DescribeProductEventListEventsDimensions

DescribeProductEventList返回的Events的Dimensions

被如下接口引用:DescribeProductEventList。

名称 类型 描述
Key String 维度名(英文)
注意:此字段可能返回 null,表示取不到有效值。
Name String 维度名(中文)
注意:此字段可能返回 null,表示取不到有效值。
Value String 维度值
注意:此字段可能返回 null,表示取不到有效值。

DescribeProductEventListEventsGroupInfo

DescribeProductEventList返回的Events里的GroupInfo

被如下接口引用:DescribeProductEventList。

名称 类型 描述
GroupId Integer 策略ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 策略名
注意:此字段可能返回 null,表示取不到有效值。

DescribeProductEventListOverView

DescribeProductEventList返回的OverView对象

被如下接口引用:DescribeProductEventList。

名称 类型 描述
StatusChangeAmount Integer 状态变更的事件数量
注意:此字段可能返回 null,表示取不到有效值。
UnConfigAlarmAmount Integer 告警状态未配置的事件数量
注意:此字段可能返回 null,表示取不到有效值。
UnNormalEventAmount Integer 异常事件数量
注意:此字段可能返回 null,表示取不到有效值。
UnRecoverAmount Integer 未恢复的事件数量
注意:此字段可能返回 null,表示取不到有效值。

Dimension

实例对象的维度组合

被如下接口引用:DescribeStatisticData, GetMonitorData。

名称 类型 必选 描述
Name String 实例维度名称
注意:此字段可能返回 null,表示取不到有效值。
Value String 实例维度值
注意:此字段可能返回 null,表示取不到有效值。

DimensionNew

策略类型的维度信息

被如下接口引用:DescribeAllNamespaces。

名称 类型 描述
Key String 维度 key 标示,后台英文名
示例值:tapm.instance.key
Name String 维度 key 名称,中英文前台展示名
示例值:业务系统
IsRequired Boolean 是否必选
示例值:true
Operators Array of Operator 支持的操作符列表
IsMultiple Boolean 是否支持多选
示例值:true
IsMutable Boolean 创建后是否可以修改
示例值:true
IsVisible Boolean 是否展示给用户
示例值:true
CanFilterPolicy Boolean 能否用来过滤策略列表
示例值:false
CanFilterHistory Boolean 能否用来过滤告警历史
示例值:false
CanGroupBy Boolean 能否作为聚合维度
示例值:true
MustGroupBy Boolean 是否必须作为聚合维度
示例值:true
ShowValueReplace String 前端翻译要替换的 key
注意:此字段可能返回 null,表示取不到有效值。

DimensionsDesc

维度信息

被如下接口引用:DescribeBaseMetrics。

名称 类型 描述
Dimensions Array of String 维度名数组

EventCondition

事件告警条件

被如下接口引用:DescribeConditionsTemplateList。

名称 类型 描述
AlarmNotifyPeriod String 告警通知频率
注意:此字段可能返回 null,表示取不到有效值。
AlarmNotifyType String 重复通知策略预定义(0 - 只告警一次, 1 - 指数告警,2 - 连接告警)
注意:此字段可能返回 null,表示取不到有效值。
EventID String 事件ID
EventDisplayName String 事件展示名称(对外)
RuleID String 规则ID

Filter

查询过滤参数

被如下接口引用:DescribePrometheusAlertPolicy, DescribePrometheusInstancesOverview, DescribePrometheusRecordRuleYaml, DescribePrometheusRecordRules, DescribePrometheusTargetsTMP, DescribePrometheusTemp。

名称 类型 必选 描述
Type String 过滤方式(=, !=, in)
示例值:=
Key String 过滤维度名
示例值:serviceName
Value String 过滤值,in过滤方式用逗号分割多个值
示例值:sso-api
Name String 过滤条件名称
示例值:abc
Values Array of String 过滤条件取值范围
示例值:["aa", "bb"]

GrafanaAccountInfo

Grafana可视化服务 授权账户信息

被如下接口引用:DescribeSSOAccount。

名称 类型 描述
UserId String 用户账号ID
示例值:1000000000
Role Array of GrafanaAccountRole 用户权限
Notes String 备注
示例值:xxx
CreateAt Timestamp ISO8601 创建时间
示例值:2021-03-11T16:54:33+08:00
InstanceId String 实例 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:grafana-xxxx
Uin String 用户主账号 UIN
示例值:11111

GrafanaAccountRole

Grafana可视化服务 账号权限

被如下接口引用:CreateSSOAccount, DescribeSSOAccount, UpdateSSOAccount。

名称 类型 必选 描述
Organization String 组织
示例值:Org
Role String 权限(Admin、Editor、Viewer)
示例值:Admin

GrafanaChannel

Grafana 告警渠道

被如下接口引用:DescribeGrafanaChannels。

名称 类型 描述
ChannelId String 渠道 ID
示例值:channel-id
ChannelName String 渠道名
示例值:channel-name
Receivers Array of String 告警通道模板 ID 数组
示例值:[]
CreatedAt Timestamp ISO8601 创建时间
示例值:2021-03-11T16:54:33+08:00
UpdatedAt Timestamp ISO8601 更新时间
示例值:2021-03-11T16:54:33+08:00
OrganizationIds Array of String 告警渠道的所有生效组织
注意:此字段可能返回 null,表示取不到有效值。
示例值:["1", "2", "3"]

GrafanaInstanceInfo

查询 Grafana 实例时的实例类型

被如下接口引用:DescribeGrafanaInstances。

名称 类型 描述
InstanceName String 实例名
示例值:my-instance
InstanceId String 实例 ID
示例值:grafana-abcdefgh
Region String 地域
示例值:ap-guangzhou
VpcId String VPC ID
示例值:vpc-abcdef
SubnetIds Array of String 子网 ID 数组
示例值:["subnet-abcdef"]
InternetUrl String Grafana 公网地址
示例值:192.168.0.1
InternalUrl String Grafana 内网地址
示例值:192.168.0.1
CreatedAt Timestamp 创建时间
示例值:2021-03-11T16:54:33+08:00
InstanceStatus Integer 运行状态(1:正在创建;2:运行中;3:异常;4:重启中;5:停机中; 6:已停机; 7: 已删除)
示例值:1
TagSpecification Array of PrometheusTag 实例的标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"key":"1","value":"2"}]
Zone String 实例的可用区
示例值:ap-guangzhou-6
InstanceChargeType Integer 计费模式(1:包年包月)
示例值:1
VpcName String VPC 名称
示例值:Default-VPC
SubnetName String 子网名称
示例值:Default-Subnet
RegionId Integer 地域 ID
示例值:1
RootUrl String 可访问此实例的完整 URL
示例值:http://127.0.0.1
EnableSSO Boolean 是否开启 SSO
示例值:true
Version String 版本号
示例值:v7.4.2
EnableSSOCamCheck Boolean SSO登录时是否开启cam鉴权
示例值:true

GrafanaIntegrationConfig

Grafana 集成实例配置

被如下接口引用:DescribeGrafanaIntegrations。

名称 类型 描述
IntegrationId String 集成 ID
示例值:my-instance
Kind String 集成类型
示例值:grafana
Content String 集成内容
示例值:"{}"
Description String 集成描述
示例值:""
GrafanaURL String Grafana 跳转地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:""

GrafanaNotificationChannel

Grafana 告警渠道

被如下接口引用:DescribeGrafanaNotificationChannels。

名称 类型 描述
ChannelId String 渠道 ID
示例值:channel-id
ChannelName String 渠道名
示例值:channel-name
Receivers Array of String 告警通道模板 ID 数组
示例值:[]
CreatedAt Timestamp ISO8601 创建时间
示例值:2021-03-11T16:54:33+08:00
UpdatedAt Timestamp ISO8601 更新时间
示例值:2021-03-11T16:54:33+08:00
OrgId String 默认生效组织,已废弃,请使用 OrganizationIds
示例值:1
ExtraOrgIds Array of String 额外生效组织,已废弃,请使用 OrganizationIds
注意:此字段可能返回 null,表示取不到有效值。
示例值:["2", "3"]
OrgIds Array of String 生效组织,已废弃,请使用 OrganizationIds
注意:此字段可能返回 null,表示取不到有效值。
示例值:["1", "2", "3"]
OrganizationIds Array of String 告警渠道的所有生效组织
注意:此字段可能返回 null,表示取不到有效值。
示例值:["1", "2", "3"]

GrafanaPlugin

Grafana 插件

被如下接口引用:DescribeInstalledPlugins, DescribePluginOverviews, InstallPlugins。

名称 类型 必选 描述
PluginId String Grafana 插件 ID
Version String Grafana 插件版本
注意:此字段可能返回 null,表示取不到有效值。

Instance

实例维度组合数组

被如下接口引用:GetMonitorData。

名称 类型 必选 描述
Dimensions Array of Dimension 实例的维度组合

InstanceGroup

DescribeBasicAlarmList返回的Alarms里的InstanceGroup

被如下接口引用:DescribeBasicAlarmList。

名称 类型 描述
InstanceGroupId Integer 实例组ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceGroupName String 实例组名
注意:此字段可能返回 null,表示取不到有效值。

InstanceGroups

告警对象所属实例组

被如下接口引用:DescribeAlarmHistories。

名称 类型 描述
Id Integer 实例组 Id
Name String 实例组名称

IntegrationConfiguration

export 集成配置

被如下接口引用:DescribeExporterIntegrations。

名称 类型 描述
Name String 名字
示例值:test
Kind String 类型
示例值:blackbox-exporter
Content String 内容
示例值:{"name":"test","kind":"blackbox-exporter","spec":{"in
Status Integer 状态
示例值:1
Category String 实例类型
示例值:MySQL
InstanceDesc String 实例描述
示例值:root:**@localhost:3306
GrafanaDashboardURL String dashboard 的 URL
示例值:http://xx

Label

k8s中标签,一般以数组的方式存在

被如下接口引用:CreatePrometheusAlertPolicy, CreatePrometheusClusterAgent, DescribePrometheusAlertPolicy, DescribePrometheusClusterAgents, ModifyPrometheusAgentExternalLabels, ModifyPrometheusAlertPolicy, ModifyPrometheusTemp。

名称 类型 必选 描述
Name String map表中的Name
示例值:xxx
Value String map表中的Value
示例值:xxx

LogAlarmReq

日志告警请求信息

被如下接口引用:CreateAlarmPolicy, ModifyAlarmPolicyCondition。

名称 类型 必选 描述
InstanceId String apm实例id
示例值:fake-instanceId
Filter Array of LogFilterInfo 检索条件信息
AlarmMerge String 告警合并开启/暂停
示例值:1
AlarmMergeTime String 告警合并时间
示例值:30

LogFilterInfo

日志告警检索条件结构体

被如下接口引用:CreateAlarmPolicy, ModifyAlarmPolicyCondition。

名称 类型 必选 描述
Key String 字段名
示例值:k1
Operator String 比较符号
示例值:eq
Value String 字段值
示例值:val1

ManagementCommand

Prometheus Agent 管理命令行

被如下接口引用:GetPrometheusAgentManagementCommand。

名称 类型 描述
Install String Agent 安装命令
注意:此字段可能返回 null,表示取不到有效值。
Restart String Agent 重启命令
注意:此字段可能返回 null,表示取不到有效值。
Stop String Agent 停止命令
注意:此字段可能返回 null,表示取不到有效值。
StatusCheck String Agent 状态检测命令
注意:此字段可能返回 null,表示取不到有效值。
LogCheck String Agent 日志检测命令
注意:此字段可能返回 null,表示取不到有效值。

Metric

指标,可用于设置告警、查询数据

被如下接口引用:DescribeAlarmMetrics。

名称 类型 描述
Namespace String 告警策略类型
示例值:cvm_device
MetricName String 指标名
示例值:CpuUsage
Description String 指标展示名
示例值:CPU利用率
Min Float 最小值
示例值:0
Max Float 最大值
示例值:100
Dimensions Array of String 维度列表
示例值:vm_uuid
Unit String 单位
示例值:%
MetricConfig MetricConfig 指标配置
注意:此字段可能返回 null,表示取不到有效值。
IsAdvanced Integer 是否为高级指标。1是 0否
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
IsOpen Integer 高级指标是否开通。1是 0否
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ProductId Integer 集成中心产品ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Operators Array of Operator 匹配运算符
注意:此字段可能返回 null,表示取不到有效值。
Periods Array of Integer 指标触发
注意:此字段可能返回 null,表示取不到有效值。

MetricConfig

指标配置

被如下接口引用:DescribeAlarmMetrics。

名称 类型 描述
Operator Array of String 允许使用的运算符
Period Array of Integer 允许配置的数据周期,以秒为单位
ContinuePeriod Array of Integer 允许配置的持续周期个数

MetricData

DescribeMetricData接口出参

被如下接口引用:DescribeStatisticData。

名称 类型 描述
MetricName String 指标名
Points Array of MetricDataPoint 监控数据点

MetricDataPoint

DescribeMetricData出参

被如下接口引用:DescribeStatisticData。

名称 类型 描述
Dimensions Array of Dimension 实例对象维度组合
Values Array of Point 数据点列表

MetricObjectMeaning

指标数据的解释

被如下接口引用:DescribeBaseMetrics。

名称 类型 描述
En String 指标英文解释
Zh String 指标中文解释

MetricSet

对业务指标的单位及支持统计周期的描述

被如下接口引用:DescribeBaseMetrics。

名称 类型 描述
Namespace String 命名空间,每个云产品会有一个命名空间
示例值:QCE/CVM
MetricName String 指标名称
示例值:AccOuttraffic
Unit String 指标使用的单位
示例值:MB
UnitCname String 指标使用的单位
示例值:""
Period Array of Integer 指标支持的统计周期,单位是秒,如60、300
示例值:[10,60]
Periods Array of PeriodsSt 统计周期内指标方式
Meaning MetricObjectMeaning 统计指标含义解释
Dimensions Array of DimensionsDesc 维度描述信息
MetricCName String 指标中文名
注意:此字段可能返回 null,表示取不到有效值。
示例值:公网出流量面积
MetricEName String 指标英文名
注意:此字段可能返回 null,表示取不到有效值。
示例值:AccOuttraffic

MidQueryCondition

DescribeMidDimensionValueList的查询条件

被如下接口引用:DescribeStatisticData。

名称 类型 必选 描述
Key String 维度
Operator String 操作符,支持等于(eq)、不等于(ne),以及in
Value Array of String 维度值,当Op是eq、ne时,只使用第一个元素

ModifyPolicyGroupCondition

修改告警策略组传入的指标阈值条件

被如下接口引用:ModifyPolicyGroup。

名称 类型 必选 描述
MetricId Integer 指标id
CalcType Integer 比较类型,1表示大于,2表示大于等于,3表示小于,4表示小于等于,5表示相等,6表示不相等
CalcValue String 检测阈值
CalcPeriod Integer 检测指标的数据周期
ContinuePeriod Integer 持续周期个数
AlarmNotifyType Integer 告警发送收敛类型。0连续告警,1指数告警
AlarmNotifyPeriod Integer 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次
RuleId Integer 规则id,不填表示新增,填写了ruleId表示在已存在的规则基础上进行修改

ModifyPolicyGroupEventCondition

修改告警策略组传入的事件告警条件

被如下接口引用:ModifyPolicyGroup。

名称 类型 必选 描述
EventId Integer 事件id
AlarmNotifyType Integer 告警发送收敛类型。0连续告警,1指数告警
AlarmNotifyPeriod Integer 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次
RuleId Integer 规则id,不填表示新增,填写了ruleId表示在已存在的规则基础上进行修改

MonitorTypeInfo

监控类型详细信息

被如下接口引用:DescribeMonitorTypes。

名称 类型 描述
Id String 监控类型ID
示例值:19023
Name String 监控类型
示例值:MT_QCE
SortId Integer 排列顺序
示例值:1

MonitorTypeNamespace

策略类型

被如下接口引用:DescribeAlarmHistories。

名称 类型 必选 描述
MonitorType String 监控类型
Namespace String 策略类型值

NoticeBindPolicys

通知模板与策略绑定关系

被如下接口引用:DeleteAlarmNotices。

名称 类型 必选 描述
NoticeId String 告警通知模板 ID
示例值:notice-xxx
PolicyIds Array of String 告警通知模板绑定的告警策略ID列表

Operator

维度支持的操作符信息

被如下接口引用:DescribeAlarmMetrics, DescribeAllNamespaces。

名称 类型 描述
Id String 运算符标识
示例值:eq
Name String 运算符展示名
示例值:=

PeriodsSt

周期内的统计方式

被如下接口引用:DescribeBaseMetrics。

名称 类型 描述
Period String 周期
StatType Array of String 统计方式

Point

监控数据点

被如下接口引用:DescribeStatisticData。

名称 类型 描述
Timestamp Integer 该监控数据点生成的时间点
Value Float 监控数据点的值
注意:此字段可能返回 null,表示取不到有效值。

PolicyGroup

策略组信息

被如下接口引用:DescribeConditionsTemplateList。

名称 类型 描述
CanSetDefault Boolean 是否可设为默认告警策略
GroupID Integer 告警策略组ID
GroupName String 告警策略组名称
InsertTime Integer 创建时间
IsDefault Integer 是否为默认告警策略
Enable Boolean 告警策略启用状态
LastEditUin Integer 最后修改人UIN
NoShieldedInstanceCount Integer 未屏蔽的实例数
ParentGroupID Integer 父策略组ID
ProjectID Integer 所属项目ID
ReceiverInfos Array of PolicyGroupReceiverInfo 告警接收对象信息
注意:此字段可能返回 null,表示取不到有效值。
Remark String 备注信息
UpdateTime Integer 修改时间
TotalInstanceCount Integer 总绑定实例数
ViewName String 视图
IsUnionRule Integer 是否为与关系规则

PolicyGroupReceiverInfo

2018版策略模板列表接收人信息

被如下接口引用:DescribeConditionsTemplateList。

名称 类型 描述
EndTime Integer 有效时段结束时间
NeedSendNotice Integer 是否需要发送通知
NotifyWay Array of String 告警接收渠道
注意:此字段可能返回 null,表示取不到有效值。
PersonInterval Integer 电话告警对个人间隔(秒)
ReceiverGroupList Array of Integer 消息接收组列表
注意:此字段可能返回 null,表示取不到有效值。
ReceiverType String 接受者类型
ReceiverUserList Array of Integer 接收人列表。通过平台接口查询到的接收人id列表
注意:此字段可能返回 null,表示取不到有效值。
RecoverNotify Array of String 告警恢复通知方式
注意:此字段可能返回 null,表示取不到有效值。
RoundInterval Integer 电话告警每轮间隔(秒)
RoundNumber Integer 电话告警轮数
SendFor Array of String 电话告警通知时机。可选"OCCUR"(告警时通知),"RECOVER"(恢复时通知)
注意:此字段可能返回 null,表示取不到有效值。
StartTime Integer 有效时段开始时间
UIDList Array of Integer 电话告警接收者uid
注意:此字段可能返回 null,表示取不到有效值。

PolicyTag

策略标签

被如下接口引用:BindingPolicyTag。

名称 类型 必选 描述
Key String 标签Key
Value String 标签Value

ProductSimple

云产品监控支持的产品简要信息

被如下接口引用:DescribeProductList。

名称 类型 描述
Namespace String 命名空间
ProductName String 产品中文名称
ProductEnName String 产品英文名称
注意:此字段可能返回 null,表示取不到有效值。

PrometheusAgent

prometheus agent

被如下接口引用:DescribePrometheusAgents。

名称 类型 描述
Name String Agent 名
注意:此字段可能返回 null,表示取不到有效值。
AgentId String Agent ID
InstanceId String 实例 ID
Ipv4 String Agent IP
注意:此字段可能返回 null,表示取不到有效值。
HeartbeatTime String 心跳时间
注意:此字段可能返回 null,表示取不到有效值。
LastError String 最近一次错误
注意:此字段可能返回 null,表示取不到有效值。
AgentVersion String Agent 版本
注意:此字段可能返回 null,表示取不到有效值。
Status Integer Agent 状态

PrometheusAgentInfo

托管Prometheus agent信息

被如下接口引用:DeletePrometheusClusterAgent。

名称 类型 必选 描述
ClusterType String 集群类型。可填入tke、eks、tkeedge、tdcc,分别代表标准集群、弹性集群、边缘集群、注册集群
示例值:tke
ClusterId String 集成容器服务中关联的集群ID
示例值:cls-abc
Describe String 该参数未使用,不需要填写
示例值:test

PrometheusAgentOverview

托管prometheus agent概览

被如下接口引用:DescribePrometheusClusterAgents。

名称 类型 描述
ClusterType String 集群类型
示例值:tke
ClusterId String 集群id
示例值:cls-xxx
Status String agent状态
normal = 正常
abnormal = 异常
示例值:normal
ClusterName String 集群名称
示例值:tke集群
ExternalLabels Array of Label 额外labels
本集群的所有指标都会带上这几个label
注意:此字段可能返回 null,表示取不到有效值。
示例值:Name=cluster_name,Value=x
Region String 集群所在地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-beijing
VpcId String 集群所在VPC ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
FailedReason String 记录关联等操作的失败信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
Name String agent名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
EnableExternal Boolean 是否已开启公网访问,true 开启,false 未开启
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
DesiredAgentNum Integer 采集agent期望pod数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ReadyAgentNum Integer 采集agent已正常启动pod数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

PrometheusAlertAllowTimeRange

Prometheus自定义告警通知时间段

被如下接口引用:CreatePrometheusAlertGroup, DescribePrometheusAlertGroups, UpdatePrometheusAlertGroup。

名称 类型 必选 描述
Start String 从0点开始的秒数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
End String 从0点开始的秒数
注意:此字段可能返回 null,表示取不到有效值。
示例值:3600

PrometheusAlertCustomReceiver

Prometheus告警自定义通知模板

被如下接口引用:CreatePrometheusAlertGroup, DescribePrometheusAlertGroups, UpdatePrometheusAlertGroup。

名称 类型 必选 描述
Type String 自定义通知类型
alertmanager -- vpc内自建alertmanager
webhook -- vpc内webhook地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:alertmanager
Url String alertmanager/webhook地址。(prometheus实例同vpc内ip)
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://192.168.10.2:9090
AllowedTimeRanges Array of PrometheusAlertAllowTimeRange 允许发送告警的时间范围
注意:此字段可能返回 null,表示取不到有效值。
示例值:{{"Start": "28800", "End": "72000"}}
ClusterId String alertmanager所在的内网集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cls-asd212as
ClusterType String alertmanager所在的内网集群类型(tke/eks/tdcc)
注意:此字段可能返回 null,表示取不到有效值。
示例值:tke

PrometheusAlertGroupRuleSet

告警分组内告警规则信息

被如下接口引用:CreatePrometheusAlertGroup, DescribePrometheusAlertGroups, UpdatePrometheusAlertGroup。

名称 类型 必选 描述
RuleName String 告警规则名称,同一告警分组下不允许重名
注意:此字段可能返回 null,表示取不到有效值。
示例值:规则-1
Labels Array of PrometheusRuleKV 标签列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{Key: "ip" Value: "1.1.1.1"}]
Annotations Array of PrometheusRuleKV 注释列表

告警对象和告警消息是 Prometheus Rule Annotations 的特殊字段,需要通过 annotations 来传递,对应的 Key 分别为summary/description。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{Key: "summary" Value: "规则名称"}]
Duration String 规则报警持续时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:5m
Expr String 规则表达式,可参考告警规则说明
注意:此字段可能返回 null,表示取不到有效值。
示例值:job:request_latency_seconds:mean5m{job="myjob"} > 0.5
State Integer 告警规则状态:
2-启用
3-禁用
为空默认启用
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

PrometheusAlertGroupSet

Prometheus告警规则分组信息

被如下接口引用:DescribePrometheusAlertGroups。

名称 类型 描述
GroupId String 告警分组ID,满足正则表达式alert-[a-z0-9]{8}
注意:此字段可能返回 null,表示取不到有效值。
示例值:alert-f2vx278
GroupName String 告警分组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:告警分组-11
AMPReceivers Array of String 云监控告警模板ID ,返回告警模板转换后的notice ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:["notice-as454a12"]
CustomReceiver PrometheusAlertCustomReceiver 自定义告警模板
注意:此字段可能返回 null,表示取不到有效值。
RepeatInterval String 告警通知间隔
注意:此字段可能返回 null,表示取不到有效值。
示例值:5m
TemplateId String 若告警分组通过模板创建,则返回模板ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:temp-sa123dsx
Rules Array of PrometheusAlertGroupRuleSet 分组内告警规则详情
注意:此字段可能返回 null,表示取不到有效值。
CreatedAt String 分组创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-07-24T17:08:16+08:00
UpdatedAt String 分组更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-07-24T17:08:16+08:00

PrometheusAlertManagerConfig

告警渠道使用自建alertmanager的配置

被如下接口引用:CreatePrometheusAlertPolicy, CreatePrometheusGlobalNotification, DescribePrometheusAlertPolicy, DescribePrometheusGlobalNotification, ModifyPrometheusAlertPolicy, ModifyPrometheusGlobalNotification, ModifyPrometheusTemp。

名称 类型 必选 描述
Url String alertmanager url
ClusterType String alertmanager部署所在集群类型
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String alertmanager部署所在集群ID
注意:此字段可能返回 null,表示取不到有效值。

PrometheusAlertPolicyItem

托管prometheus告警策略实例

被如下接口引用:CreatePrometheusAlertPolicy, CreatePrometheusTemp, DescribePrometheusAlertPolicy, DescribePrometheusTemp, ModifyPrometheusAlertPolicy, ModifyPrometheusTemp。

名称 类型 必选 描述
Name String 策略名称
Rules Array of PrometheusAlertRule 规则列表
Id String 告警策略 id
注意:此字段可能返回 null,表示取不到有效值。
TemplateId String 如果该告警来自模板下发,则TemplateId为模板id
注意:此字段可能返回 null,表示取不到有效值。
Notification PrometheusNotificationItem 告警渠道,模板中使用可能返回null
注意:此字段可能返回 null,表示取不到有效值。
UpdatedAt String 最后修改时间
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 如果告警策略来源于用户集群CRD资源定义,则ClusterId为所属集群ID
注意:此字段可能返回 null,表示取不到有效值。

PrometheusAlertRule

Prometheus告警规则

被如下接口引用:CreatePrometheusAlertPolicy, DescribePrometheusAlertPolicy, ModifyPrometheusAlertPolicy, ModifyPrometheusTemp。

名称 类型 必选 描述
Name String 规则名称
示例值:Example
Rule String prometheus语句
示例值:Example
Labels Array of Label 额外标签
示例值:Name=a,Value=b
Template String 告警发送模板
示例值:temp-xxx
For String 持续时间
示例值:1s
Describe String 该条规则的描述信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:example-describe
Annotations Array of Label 参考prometheus rule中的annotations
注意:此字段可能返回 null,表示取不到有效值。
示例值:Name=a,Value=b
RuleState Integer 告警规则状态
注意:此字段可能返回 null,表示取不到有效值。

PrometheusClusterAgentBasic

与腾讯云可观测平台融合托管 Prometheus 实例,关联集群基础信息

被如下接口引用:CreatePrometheusClusterAgent。

名称 类型 必选 描述
Region String 集群ID
示例值:xx-xxx
ClusterType String 集群类型
示例值:tke
ClusterId String 集群ID
示例值:cls-xxx
EnableExternal Boolean 是否开启公网CLB
示例值:false
InClusterPodConfig PrometheusClusterAgentPodConfig 集群内部署组件的pod配置
示例值:pod配置
ExternalLabels Array of Label 该集群采集的所有指标都会带上这些labels
示例值:额外的labels
NotInstallBasicScrape Boolean 是否安装默认采集配置
NotScrape Boolean 是否采集指标,true代表drop所有指标,false代表采集默认指标
OpenDefaultRecord Boolean 是否开启默认预聚合规则

PrometheusClusterAgentPodConfig

关联集群时在集群内部署组件的pod额外配置

被如下接口引用:CreatePrometheusClusterAgent。

名称 类型 必选 描述
HostNet Boolean 是否使用HostNetWork
示例值:true
NodeSelector Array of Label 指定pod运行节点
Tolerations Array of Toleration 容忍污点

PrometheusConfigItem

prometheus配置

被如下接口引用:CreatePrometheusConfig, CreatePrometheusTemp, DescribePrometheusConfig, DescribePrometheusGlobalConfig, DescribePrometheusTemp, ModifyPrometheusConfig, ModifyPrometheusTemp。

名称 类型 必选 描述
Name String 名称
示例值:xxx
Config String 配置内容
示例值:xxx
TemplateId String 用于出参,如果该配置来至模板,则为模板id
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
Targets Targets 目标数
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx

PrometheusInstanceGrantInfo

实例的授权信息

被如下接口引用:DescribePrometheusInstances。

名称 类型 描述
HasChargeOperation Integer 是否有计费操作权限(1=有,2=无)
示例值:1
HasVpcDisplay Integer 是否显示VPC信息的权限(1=有,2=无)
示例值:1
HasGrafanaStatusChange Integer 是否可修改Grafana的状态(1=有,2=无)
示例值:1
HasAgentManage Integer 是否有管理agent的权限(1=有,2=无)
示例值:1
HasTkeManage Integer 是否有管理TKE集成的权限(1=有,2=无)
示例值:1
HasApiOperation Integer 是否显示API等信息(1=有, 2=无)
示例值:1

PrometheusInstanceTenantUsage

Prometheus用量信息

被如下接口引用:DescribePrometheusInstanceUsage。

名称 类型 描述
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:prom-xxxx
CalcDate String 计费周期
注意:此字段可能返回 null,表示取不到有效值。
示例值:20210101
Total Float 总用量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.1
Basic Float 基础指标用量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.1
Fee Float 付费指标用量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.1

PrometheusInstancesItem

Prometheus 服务响应体

被如下接口引用:DescribePrometheusInstances。

名称 类型 描述
InstanceId String 实例ID。
示例值:prom-123456
InstanceName String 实例名称。
示例值:test
InstanceChargeType Integer 实例计费模式。取值范围:

  • 2:包年包月
  • 3:按量


示例值:2
RegionId Integer 地域 ID
示例值:1
Zone String 可用区
示例值:ap-guangzhou-1
VpcId String VPC ID
示例值:vpc-123456
SubnetId String 子网 ID
示例值:subnet-123456
DataRetentionTime Integer 存储周期
注意:此字段可能返回 null,表示取不到有效值。
示例值:15
InstanceStatus Integer 实例业务状态。取值范围:

  • 1:正在创建
  • 2:运行中
  • 3:异常
  • 4:重建中
  • 5:销毁中
  • 6:已停服
  • 8:欠费停服中
  • 9:欠费已停服


示例值:2
GrafanaURL String Grafana 面板 URL
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://url
CreatedAt String 创建时间
示例值:2021-01-01 00:00:00
EnableGrafana Integer 是否开启 Grafana
  • 0:不开启
  • 1:开启

  • 示例值:1
    IPv4Address String 实例IPV4地址
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:192.168.1.2
    TagSpecification Array of PrometheusTag 实例关联的标签列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    ExpireTime String 购买的实例过期时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-01-01 00:00:00
    ChargeStatus Integer 计费状态

    • 1:正常
    • 2:过期
    • 3:销毁
    • 4:分配中
    • 5:分配失败


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    SpecName String 规格名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:基础1
    AutoRenewFlag Integer 自动续费标记

    • 0:不自动续费
    • 1:开启自动续费
    • 2:禁止自动续费
    • -1:无效

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    IsNearExpire Integer 是否快过期

    • 0:否
    • 1:快过期


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    AuthToken String 数据写入需要的 Token
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:token
    RemoteWrite String Prometheus Remote Write 的地址
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://url
    ApiRootPath String Prometheus HTTP Api 根地址
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://url
    ProxyAddress String Proxy 的地址
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://url
    GrafanaStatus Integer Grafana 运行状态

    • 1:正在创建
    • 2:运行中
    • 3:异常
    • 4:重启中
    • 5:销毁中
    • 6:已停机
    • 7:已删除


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2
    GrafanaIpWhiteList String Grafana IP 白名单列表,使用英文分号分隔
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:192.168.1.2
    Grant PrometheusInstanceGrantInfo 实例的授权信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    GrafanaInstanceId String 绑定的 Grafana 实例 ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:grafana-xxxx
    AlertRuleLimit Integer 告警规则限制
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:150
    RecordingRuleLimit Integer 预聚合规则限制
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:150
    MigrationType Integer 迁移状态,0-不在迁移中,1-迁移中、原实例,2-迁移中、目标实例
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    PrometheusInstancesOverview

    托管prometheusV2实例概览

    被如下接口引用:DescribePrometheusInstancesOverview。

    名称 类型 描述
    InstanceId String 实例ID
    示例值:prom-xxx
    InstanceName String 实例名
    示例值:xxx
    VpcId String VPC ID
    示例值:vpc-xxx
    SubnetId String 子网ID
    示例值:subnet-xxx
    InstanceStatus Integer 运行状态(1:正在创建;2:运行中;3:异常;4:重启中;5:销毁中; 6:已停机; 7: 已删除)
    示例值:2
    ChargeStatus Integer 计费状态(1:正常;2:过期; 3:销毁; 4:分配中; 5:分配失败)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    EnableGrafana Integer 是否开启 Grafana(0:不开启,1:开启)
    示例值:1
    GrafanaURL String Grafana 面板 URL
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:https://prom-xxx.grafana.xxx.prom.tencent-cloud.com
    InstanceChargeType Integer 实例付费类型(1:试用版;2:预付费)
    示例值:2
    SpecName String 规格名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:基础1
    DataRetentionTime Integer 存储周期
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:15
    ExpireTime String 购买的实例过期时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-12-14T17:16:12+08:00
    AutoRenewFlag Integer 自动续费标记(0:不自动续费;1:开启自动续费;2:禁止自动续费;-1:无效)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    BoundTotal Integer 绑定集群总数
    示例值:2
    BoundNormal Integer 绑定集群正常状态总数
    示例值:2
    ResourcePackageStatus Integer 资源包状态,0-无可用资源包,1-有可用资源包
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    ResourcePackageSpecName String 资源包规格名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:”xxxx“

    PrometheusJobTargets

    prometheus一个job的targets

    被如下接口引用:DescribePrometheusTargetsTMP。

    名称 类型 描述
    Targets Array of PrometheusTarget 该Job的targets列表
    示例值:xxx
    JobName String job的名称
    示例值:xxx
    Total Integer targets总数
    示例值:xxx
    Up Integer 健康的target总数
    示例值:xxx

    PrometheusNotificationItem

    告警通知渠道配置

    被如下接口引用:CreatePrometheusAlertPolicy, CreatePrometheusGlobalNotification, DescribePrometheusAlertPolicy, DescribePrometheusGlobalNotification, ModifyPrometheusAlertPolicy, ModifyPrometheusGlobalNotification, ModifyPrometheusTemp。

    名称 类型 必选 描述
    Enabled Boolean 是否启用
    Type String 通道类型,默认为amp,支持以下
    amp
    webhook
    alertmanager
    WebHook String 如果Type为webhook, 则该字段为必填项
    注意:此字段可能返回 null,表示取不到有效值。
    AlertManager PrometheusAlertManagerConfig 如果Type为alertmanager, 则该字段为必填项
    注意:此字段可能返回 null,表示取不到有效值。
    RepeatInterval String 收敛时间
    TimeRangeStart String 生效起始时间
    TimeRangeEnd String 生效结束时间
    NotifyWay Array of String 告警通知方式。目前有SMS、EMAIL、CALL、WECHAT方式。
    注意:此字段可能返回 null,表示取不到有效值。
    ReceiverGroups Array of String 告警接收组(用户组)
    注意:此字段可能返回 null,表示取不到有效值。
    PhoneNotifyOrder Array of Integer 电话告警顺序。
    注:NotifyWay选择CALL,采用该参数。
    注意:此字段可能返回 null,表示取不到有效值。
    PhoneCircleTimes Integer 电话告警次数。
    注:NotifyWay选择CALL,采用该参数。
    注意:此字段可能返回 null,表示取不到有效值。
    PhoneInnerInterval Integer 电话告警轮内间隔。单位:秒
    注:NotifyWay选择CALL,采用该参数。
    注意:此字段可能返回 null,表示取不到有效值。
    PhoneCircleInterval Integer 电话告警轮外间隔。单位:秒
    注:NotifyWay选择CALL,采用该参数。
    注意:此字段可能返回 null,表示取不到有效值。
    PhoneArriveNotice Boolean 电话告警触达通知
    注:NotifyWay选择CALL,采用该参数。
    注意:此字段可能返回 null,表示取不到有效值。

    PrometheusRecordRuleYamlItem

    prometheus聚合规则实例详情,包含所属集群ID

    被如下接口引用:DescribePrometheusRecordRules。

    名称 类型 描述
    Name String 实例名称
    UpdateTime String 最近更新时间
    TemplateId String Yaml内容
    Content String 如果该聚合规则来至模板,则TemplateId为模板id
    注意:此字段可能返回 null,表示取不到有效值。
    ClusterId String 该聚合规则如果来源于用户集群crd资源定义,则ClusterId为所属集群ID
    注意:此字段可能返回 null,表示取不到有效值。
    Status Integer 状态
    注意:此字段可能返回 null,表示取不到有效值。
    Id String id
    注意:此字段可能返回 null,表示取不到有效值。
    Count Integer 规则数量
    注意:此字段可能返回 null,表示取不到有效值。

    PrometheusRegionItem

    DescribePrometheusRegions 响应结构体

    被如下接口引用:DescribePrometheusRegions。

    名称 类型 描述
    Region String 区域
    示例值:ap-guangzhou
    RegionId Integer 区域 ID
    示例值:1
    RegionState Integer 区域状态( 0: 不可用;1: 可用)
    示例值:1
    RegionName String 区域名(中文)
    示例值:广州
    RegionShortName String 区域名(英文缩写)
    示例值:gz
    Area String 区域所在大区名
    示例值:华南地区
    RegionPayMode Integer 1-仅支持预付费,2-仅支持后付费,3-支持两种计费模式实例
    示例值:3

    PrometheusRuleKV

    prometheus 报警规则 KV 参数

    被如下接口引用:CreateAlertRule, CreatePrometheusAlertGroup, DescribeAlertRules, DescribePrometheusAlertGroups, UpdateAlertRule, UpdatePrometheusAlertGroup。

    名称 类型 必选 描述
    Key String
    Value String

    PrometheusRuleSet

    prometheus 报警规则集

    被如下接口引用:DescribeAlertRules。

    名称 类型 描述
    RuleId String 规则 ID
    RuleName String 规则名称
    RuleState Integer 规则状态码
    Type String 规则类别
    注意:此字段可能返回 null,表示取不到有效值。
    Labels Array of PrometheusRuleKV 规则标签列表
    注意:此字段可能返回 null,表示取不到有效值。
    Annotations Array of PrometheusRuleKV 规则注释列表
    注意:此字段可能返回 null,表示取不到有效值。
    Expr String 规则表达式
    注意:此字段可能返回 null,表示取不到有效值。
    Duration String 规则报警持续时间
    注意:此字段可能返回 null,表示取不到有效值。
    Receivers Array of String 报警接收组列表
    注意:此字段可能返回 null,表示取不到有效值。
    Health String 规则运行健康状态,取值如下:
  • unknown 未知状态
  • pending 加载中
  • ok 运行正常
  • err 运行错误
  • CreatedAt String 规则创建时间
    注意:此字段可能返回 null,表示取不到有效值。
    UpdatedAt String 规则更新时间
    注意:此字段可能返回 null,表示取不到有效值。

    PrometheusScrapeJob

    Prometheus 抓取任务

    被如下接口引用:DescribePrometheusScrapeJobs。

    名称 类型 描述
    Name String 任务名
    注意:此字段可能返回 null,表示取不到有效值。
    AgentId String Agent ID
    JobId String 任务 ID
    Config String 配置
    注意:此字段可能返回 null,表示取不到有效值。

    PrometheusTag

    Prometheus 托管服务标签

    被如下接口引用:CreateGrafanaInstance, CreatePrometheusMultiTenantInstancePostPayMode, DescribeGrafanaInstances, DescribePrometheusInstances。

    名称 类型 必选 描述
    Key String 标签的健值
    Value String 标签对应的值
    注意:此字段可能返回 null,表示取不到有效值。

    PrometheusTarget

    prometheus一个抓取目标的信息

    被如下接口引用:DescribePrometheusTargetsTMP。

    名称 类型 描述

    PrometheusTemp

    模板实例

    被如下接口引用:CreatePrometheusTemp, DescribePrometheusTemp。

    名称 类型 必选 描述
    Name String 模板名称
    Level String 模板维度,支持以下类型
    instance 实例级别
    cluster 集群级别
    Describe String 模板描述
    注意:此字段可能返回 null,表示取不到有效值。
    RecordRules Array of PrometheusConfigItem 当Level为instance时有效,
    模板中的聚合规则列表
    注意:此字段可能返回 null,表示取不到有效值。
    ServiceMonitors Array of PrometheusConfigItem 当Level为cluster时有效,
    模板中的ServiceMonitor规则列表
    注意:此字段可能返回 null,表示取不到有效值。
    PodMonitors Array of PrometheusConfigItem 当Level为cluster时有效,
    模板中的PodMonitors规则列表
    注意:此字段可能返回 null,表示取不到有效值。
    RawJobs Array of PrometheusConfigItem 当Level为cluster时有效,
    模板中的RawJobs规则列表
    注意:此字段可能返回 null,表示取不到有效值。
    TemplateId String 模板的ID, 用于出参
    注意:此字段可能返回 null,表示取不到有效值。
    UpdateTime String 最近更新时间,用于出参
    注意:此字段可能返回 null,表示取不到有效值。
    Version String 当前版本,用于出参
    注意:此字段可能返回 null,表示取不到有效值。
    IsDefault Boolean 是否系统提供的默认模板,用于出参
    注意:此字段可能返回 null,表示取不到有效值。
    AlertDetailRules Array of PrometheusAlertPolicyItem 当Level为instance时有效,
    模板中的告警配置列表
    注意:此字段可能返回 null,表示取不到有效值。
    TargetsTotal Integer 关联实例数目
    注意:此字段可能返回 null,表示取不到有效值。

    PrometheusTempModify

    云原生Prometheus模板可修改项

    被如下接口引用:ModifyPrometheusTemp。

    名称 类型 必选 描述
    Name String 修改名称
    Describe String 修改描述
    注意:此字段可能返回 null,表示取不到有效值。
    ServiceMonitors Array of PrometheusConfigItem 当Level为cluster时有效,
    模板中的ServiceMonitor规则列表
    注意:此字段可能返回 null,表示取不到有效值。
    PodMonitors Array of PrometheusConfigItem 当Level为cluster时有效,
    模板中的PodMonitors规则列表
    注意:此字段可能返回 null,表示取不到有效值。
    RawJobs Array of PrometheusConfigItem 当Level为cluster时有效,
    模板中的RawJobs规则列表
    注意:此字段可能返回 null,表示取不到有效值。
    RecordRules Array of PrometheusConfigItem 当Level为instance时有效,
    模板中的聚合规则列表
    注意:此字段可能返回 null,表示取不到有效值。
    AlertDetailRules Array of PrometheusAlertPolicyItem 修改内容,只有当模板类型是Alert时生效
    注意:此字段可能返回 null,表示取不到有效值。

    PrometheusTemplateSyncTarget

    云原生Prometheus模板同步目标

    被如下接口引用:DeletePrometheusTempSync, DescribePrometheusTempSync, SyncPrometheusTemp。

    名称 类型 必选 描述
    Region String 目标所在地域
    示例值:xxx
    InstanceId String 目标实例
    示例值:xxx
    ClusterId String 集群id,只有当采集模板的Level为cluster的时候需要
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx
    SyncTime String 最后一次同步时间, 用于出参
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx
    Version String 当前使用的模板版本,用于出参
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx
    ClusterType String 集群类型,只有当采集模板的Level为cluster的时候需要
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx
    InstanceName String 用于出参,实例名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx
    ClusterName String 用于出参,集群名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx

    PrometheusZoneItem

    PrometheusZoneItem 响应结构体内的地域信息

    被如下接口引用:DescribePrometheusZones。

    名称 类型 描述
    Zone String 可用区
    ZoneId Integer 可用区 ID
    ZoneState Integer 可用区状态( 0: 不可用;1: 可用)
    RegionId Integer 地域 ID
    ZoneName String 可用区名(目前为中文)
    ZoneResourceState Integer 可用区资源状态(0:资源不足,不可使用;1:资源足够)
    注意:此字段可能返回 null,表示取不到有效值。

    ReceiverInfo

    接收人信息

    被如下接口引用:ModifyAlarmReceivers。

    名称 类型 必选 描述
    StartTime Integer 告警时间段开始时间。范围[0,86400),作为 UNIX 时间戳转成北京时间后去掉日期,例如7200表示"10:0:0"
    EndTime Integer 告警时间段结束时间。含义同StartTime
    NotifyWay Array of String 告警通知方式。可选 "SMS","SITE","EMAIL","CALL","WECHAT"
    ReceiverType String 接收人类型。“group” 或 “user”
    Id Integer ReceiverId
    SendFor Array of String 电话告警通知时机。可选"OCCUR"(告警时通知),"RECOVER"(恢复时通知)
    UidList Array of Integer 电话告警接收者 UID
    RoundNumber Integer 电话告警轮数
    PersonInterval Integer 电话告警对个人间隔(秒)
    RoundInterval Integer 电话告警每轮间隔(秒)
    RecoverNotify Array of String 恢复通知方式。可选"SMS"
    NeedSendNotice Integer 是否需要电话告警触达提示。0不需要,1需要
    ReceiverGroupList Array of Integer 接收组列表。通过平台接口查询到的接收组 ID 列表
    ReceiverUserList Array of Integer 接收人列表。通过平台接口查询到的接收人 ID 列表
    ReceiveLanguage String 告警接收语言,枚举值(zh-CN,en-US)

    RecordingRuleSet

    Prometheus 聚合规则响应结构体内信息

    被如下接口引用:DescribeRecordingRules。

    名称 类型 描述
    RuleId String 规则 ID
    示例值:arule-xxx
    RuleState Integer 规则状态码
    示例值:1
    Name String 分组名称
    示例值:groupname
    Group String 规则内容组
    示例值:groupname
    Total Integer 规则数量
    示例值:1
    CreatedAt String 规则创建时间
    示例值:""
    UpdatedAt String 规则最近更新时间
    示例值:""
    RuleName String 规则名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:examplename

    ServiceDiscoveryItem

    Prometheus 服务发现信息

    被如下接口引用:CreateServiceDiscovery, DescribeServiceDiscovery, UpdateServiceDiscovery。

    名称 类型 描述
    Name String 服务发现名称
    Namespace String 服务发现属于的 Namespace
    Kind String 服务发现类型: ServiceMonitor/PodMonitor
    NamespaceSelector String Namespace 选取方式
    注意:此字段可能返回 null,表示取不到有效值。
    Selector String Label 选取方式
    注意:此字段可能返回 null,表示取不到有效值。
    Endpoints String Endpoints 信息(PodMonitor 不含该参数)
    Yaml String 服务发现对应的配置信息
    注意:此字段可能返回 null,表示取不到有效值。

    Tag

    标签

    被如下接口引用:CreateAlarmNotice, CreateAlarmPolicy, DescribeAlarmNotice, DescribeAlarmNotices, DescribeAlarmPolicies, DescribeAlarmPolicy。

    名称 类型 必选 描述
    Key String 标签key
    示例值:"abc"
    Value String 标签value
    示例值:"abc"

    TagInstance

    策略列表详情标签返回体

    被如下接口引用:DescribeAlarmPolicies, DescribeAlarmPolicy。

    名称 类型 描述
    Key String 标签Key
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:tag
    Value String 标签Value
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:value
    InstanceSum Integer 实例个数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    ServiceType String 产品类型,如:cvm
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cvm
    RegionId Integer 地域ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    BindingStatus Integer 绑定状态,2:绑定成功,1:绑定中
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2
    TagStatus Integer 标签状态,2:标签存在,1:标签不存在
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2

    Targets

    抓取目标数

    被如下接口引用:CreatePrometheusConfig, DescribePrometheusConfig, DescribePrometheusGlobalConfig, ModifyPrometheusConfig, ModifyPrometheusTemp。

    名称 类型 必选 描述
    Total Integer 总数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Up Integer 在线数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Down Integer 不在线数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Unknown Integer 未知状态数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    TaskStepInfo

    任务步骤信息

    被如下接口引用:DescribePrometheusInstanceInitStatus。

    名称 类型 描述
    Step String 步骤名称
    示例值:preCheck
    LifeState String 生命周期
    pending : 步骤未开始
    running: 步骤执行中
    success: 步骤成功完成
    failed: 步骤失败
    示例值:success
    StartAt String 步骤开始时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2022-04-19T07:29:46Z
    EndAt String 步骤结束时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2022-04-19T07:29:46Z
    FailedMsg String 若步骤生命周期为failed,则此字段显示错误信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:显示错误信息

    TemplateGroup

    模板列表

    被如下接口引用:DescribeConditionsTemplateList。

    名称 类型 描述
    Conditions Array of Condition 指标告警规则
    注意:此字段可能返回 null,表示取不到有效值。
    EventConditions Array of EventCondition 事件告警规则
    注意:此字段可能返回 null,表示取不到有效值。
    PolicyGroups Array of PolicyGroup 关联告警策略组
    注意:此字段可能返回 null,表示取不到有效值。
    GroupID Integer 模板策略组ID
    示例值:1
    GroupName String 模板策略组名称
    示例值:test
    InsertTime Integer 创建时间
    示例值:11
    LastEditUin Integer 最后修改人UIN
    示例值:1
    Remark String 备注
    示例值:""
    UpdateTime Integer 更新时间
    示例值:1
    ViewName String 视图
    示例值:cvm_device
    IsUnionRule Integer 是否为与关系
    示例值:1

    Toleration

    kubernetes Taint

    被如下接口引用:CreatePrometheusClusterAgent。

    名称 类型 必选 描述
    Key String 容忍应用到的 taint key
    Operator String 键与值的关系
    Effect String 要匹配的污点效果

    URLNotice

    告警通知模板 - 回调通知详情

    被如下接口引用:CreateAlarmNotice, DescribeAlarmNotice, DescribeAlarmNoticeCallbacks, DescribeAlarmNotices, ModifyAlarmNotice。

    名称 类型 必选 描述
    URL String 回调 url(限长256字符)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://www.123.com
    IsValid Integer 是否通过验证 0=否 1=是
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    ValidationCode String 验证码
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:82hf8t
    StartTime Integer 通知开始时间 一天开始的秒数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    EndTime Integer 通知结束时间 一天开始的秒数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:86399
    Weekday Array of Integer 通知周期 1-7表示周一到周日
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[1,2,5]

    UserNotice

    告警通知模板 - 用户通知详情

    被如下接口引用:CreateAlarmNotice, DescribeAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice。

    名称 类型 必选 描述
    ReceiverType String 接收者类型 USER=用户 GROUP=用户组
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:USER
    StartTime Integer 通知开始时间 00:00:00 开始的秒数(取值范围0-86399)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    EndTime Integer 通知结束时间 00:00:00 开始的秒数(取值范围0-86399)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:86399
    NoticeWay Array of String 通知渠道列表 EMAIL=邮件 SMS=短信 CALL=电话 WECHAT=微信 RTX=企业微信
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["SMS", "CALL"]
    UserIds Array of Integer 用户 uid 列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[100001,100002]
    GroupIds Array of Integer 用户组 group id 列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[10001,10002]
    PhoneOrder Array of Integer 电话轮询列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[100001,100002]
    PhoneCircleTimes Integer 电话轮询次数 (取值范围1-5)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    PhoneInnerInterval Integer 单次轮询内拨打间隔 秒数 (取值范围60-900)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:60
    PhoneCircleInterval Integer 两次轮询间隔 秒数(取值范围60-900)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:60
    NeedPhoneArriveNotice Integer 是否需要触达通知 0=否 1=是
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    PhoneCallType String 电话拨打类型 SYNC=同时拨打 CIRCLE=轮询拨打 不指定时默认是轮询
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:SYNC
    Weekday Array of Integer 通知周期 1-7表示周一到周日
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[1,2,5]
    OnCallFormIDs Array of String 值班表id列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[“form-10001”,“form-10002”]