操作指南

云产品指标

API 文档

数据结构

最近更新时间:2021-09-23 08:10:48

我的收藏

AlarmEvent

告警事件

被如下接口引用:DescribeAlarmEvents。

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

AlarmHistory

告警历史数据

被如下接口引用:DescribeAlarmHistories。

名称 类型 描述
AlarmId String 告警历史Id
MonitorType String 监控类型
Namespace String 策略类型
AlarmObject String 告警对象
Content String 告警内容
FirstOccurTime Integer 时间戳,首次出现时间
LastOccurTime Integer 时间戳,最后出现时间
AlarmStatus String 告警状态,ALARM=未恢复 OK=已恢复 NO_CONF=已失效 NO_DATA=数据不足
PolicyId String 告警策略 Id
PolicyName String 策略名称
VPC String 基础产品告警的告警对象所属网络
ProjectId Integer 项目 Id
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
AlarmType String 告警类型
EventId Integer 事件Id
Region String 地域
PolicyExists Integer 策略是否存在 0=不存在 1=存在
MetricsInfo Array of AlarmHistoryMetric 指标信息
注意:此字段可能返回 null,表示取不到有效值。
Dimensions String 告警实例的维度信息
注意:此字段可能返回 null,表示取不到有效值。

AlarmHistoryMetric

告警历史的指标信息

被如下接口引用:DescribeAlarmHistories。

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

AlarmNotice

告警通知模板详情

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

名称 类型 描述
Id String 告警通知模板 ID
注意:此字段可能返回 null,表示取不到有效值。
Name String 告警通知模板名称
注意:此字段可能返回 null,表示取不到有效值。
UpdatedAt String 上次修改时间
注意:此字段可能返回 null,表示取不到有效值。
UpdatedBy String 上次修改人
注意:此字段可能返回 null,表示取不到有效值。
NoticeType String 告警通知类型 ALARM=未恢复通知 OK=已恢复通知 ALL=全部通知
注意:此字段可能返回 null,表示取不到有效值。
UserNotices Array of UserNotice 用户通知列表
注意:此字段可能返回 null,表示取不到有效值。
URLNotices Array of URLNotice 回调通知列表
注意:此字段可能返回 null,表示取不到有效值。
IsPreset Integer 是否是系统预设通知模板 0=否 1=是
注意:此字段可能返回 null,表示取不到有效值。
NoticeLanguage String 通知语言 zh-CN=中文 en-US=英文
注意:此字段可能返回 null,表示取不到有效值。
PolicyIds Array of String 告警通知模板绑定的告警策略ID列表
注意:此字段可能返回 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,表示取不到有效值。

AlarmPolicyCondition

告警策略指标触发条件

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

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

AlarmPolicyEventCondition

告警策略事件触发条件

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

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

AlarmPolicyFilter

告警策略过滤条件

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

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

AlarmPolicyRule

告警策略触发条件

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

名称 类型 必选 描述
MetricName String 指标名或事件名,支持的指标可以从 DescribeAlarmMetrics 查询,支持的事件可以从 DescribeAlarmEvents 查询 。
注意:此字段可能返回 null,表示取不到有效值。
Period Integer 秒数 统计周期,支持的值可以从 DescribeAlarmMetrics 查询。
注意:此字段可能返回 null,表示取不到有效值。
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,表示取不到有效值。
Value String 阈值,支持的范围可以从 DescribeAlarmMetrics 查询。
注意:此字段可能返回 null,表示取不到有效值。
ContinuePeriod Integer 周期数 持续通知周期 1=持续1个周期 2=持续2个周期...,支持的值可以从 DescribeAlarmMetrics 查询
注意:此字段可能返回 null,表示取不到有效值。
NoticeFrequency Integer 秒数 告警间隔 0=不重复 300=每5分钟告警一次 600=每10分钟告警一次 900=每15分钟告警一次 1800=每30分钟告警一次 3600=每1小时告警一次 7200=每2小时告警一次 10800=每3小时告警一次 21600=每6小时告警一次 43200=每12小时告警一次 86400=每1天告警一次
注意:此字段可能返回 null,表示取不到有效值。
IsPowerNotice Integer 告警频率是否指数增长 0=否 1=是
注意:此字段可能返回 null,表示取不到有效值。
Filter AlarmPolicyFilter 对于单个触发规则的过滤条件
注意:此字段可能返回 null,表示取不到有效值。
Description String 指标展示名,用于出参
注意:此字段可能返回 null,表示取不到有效值。
Unit String 单位,用于出参
注意:此字段可能返回 null,表示取不到有效值。
RuleType String 触发条件类型 STATIC=静态阈值 DYNAMIC=动态阈值。创建或编辑策略时,如不填则默认为 STATIC。
注意:此字段可能返回 null,表示取不到有效值。

AlarmPolicyTriggerTask

告警策略触发任务

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

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

BindingPolicyObjectDimension

策略绑定实例维度信息

被如下接口引用:BindingPolicyObject。

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

CommonNamespace

统一的命名空间信息

被如下接口引用:DescribeAllNamespaces。

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

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一一对应

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,表示取不到有效值。

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 指标单位

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,表示取不到有效值。
EventCName String 事件中文名
注意:此字段可能返回 null,表示取不到有效值。
EventEName String 事件英文名
注意:此字段可能返回 null,表示取不到有效值。
EventName String 事件简称
注意:此字段可能返回 null,表示取不到有效值。
ProductCName String 产品中文名
注意:此字段可能返回 null,表示取不到有效值。
ProductEName String 产品英文名
注意:此字段可能返回 null,表示取不到有效值。
ProductName String 产品简称
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 实例名称
注意:此字段可能返回 null,表示取不到有效值。
ProjectId String 项目ID
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
Status String 状态
注意:此字段可能返回 null,表示取不到有效值。
SupportAlarm Integer 是否支持告警
注意:此字段可能返回 null,表示取不到有效值。
Type String 事件类型
注意:此字段可能返回 null,表示取不到有效值。
StartTime Integer 开始时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。
Dimensions Array of DescribeProductEventListEventsDimensions 实例对象信息
注意:此字段可能返回 null,表示取不到有效值。
AdditionMsg Array of DescribeProductEventListEventsDimensions 实例对象附加信息
注意:此字段可能返回 null,表示取不到有效值。
IsAlarmConfig Integer 是否配置告警
注意:此字段可能返回 null,表示取不到有效值。
GroupInfo Array of DescribeProductEventListEventsGroupInfo 策略信息
注意:此字段可能返回 null,表示取不到有效值。
ViewName String 显示名称ViewName
注意:此字段可能返回 null,表示取不到有效值。

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 实例维度名称
Value String 实例维度值

DimensionsDesc

维度信息

被如下接口引用:DescribeBaseMetrics。

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

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 实例组名称

Metric

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

被如下接口引用:DescribeAlarmMetrics。

名称 类型 描述
Namespace String 告警策略类型
MetricName String 指标名
Description String 指标展示名
Min Float 最小值
Max Float 最大值
Dimensions Array of String 维度列表
Unit String 单位
MetricConfig MetricConfig 指标配置
注意:此字段可能返回 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 数据点列表

MetricDatum

指标名称和值的封装

被如下接口引用:PutMonitorData。

名称 类型 必选 描述
MetricName String 指标名称
Value Integer 指标的值

MetricObjectMeaning

指标数据的解释

被如下接口引用:DescribeBaseMetrics。

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

MetricSet

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

被如下接口引用:DescribeBaseMetrics。

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

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表示在已存在的规则基础上进行修改

MonitorTypeNamespace

策略类型

被如下接口引用:DescribeAlarmHistories。

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

PeriodsSt

周期内的统计方式

被如下接口引用:DescribeBaseMetrics。

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

Point

监控数据点

被如下接口引用:DescribeStatisticData。

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

ProductSimple

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

被如下接口引用:DescribeProductList。

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

PrometheusRuleKV

prometheus 报警规则 KV 参数

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

名称 类型 必选 描述
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,表示取不到有效值。

    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)

    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,表示取不到有效值。

    TagInstance

    策略列表详情标签返回体

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

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

    URLNotice

    云监控告警通知模板 - 回调通知详情

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

    名称 类型 必选 描述
    URL String 回调 url(限长256字符)
    注意:此字段可能返回 null,表示取不到有效值。
    IsValid Integer 是否通过验证 0=否 1=是
    注意:此字段可能返回 null,表示取不到有效值。
    ValidationCode String 验证码
    注意:此字段可能返回 null,表示取不到有效值。

    UserNotice

    云监控告警通知模板 - 用户通知详情

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

    名称 类型 必选 描述
    ReceiverType String 接收者类型 USER=用户 GROUP=用户组
    注意:此字段可能返回 null,表示取不到有效值。
    StartTime Integer 通知开始时间 00:00:00 开始的秒数(取值范围0-86399)
    注意:此字段可能返回 null,表示取不到有效值。
    EndTime Integer 通知结束时间 00:00:00 开始的秒数(取值范围0-86399)
    注意:此字段可能返回 null,表示取不到有效值。
    NoticeWay Array of String 通知渠道列表 EMAIL=邮件 SMS=短信 CALL=电话 WECHAT=微信
    注意:此字段可能返回 null,表示取不到有效值。
    UserIds Array of Integer 用户 uid 列表
    注意:此字段可能返回 null,表示取不到有效值。
    GroupIds Array of Integer 用户组 group id 列表
    注意:此字段可能返回 null,表示取不到有效值。
    PhoneOrder Array of Integer 电话轮询列表
    注意:此字段可能返回 null,表示取不到有效值。
    PhoneCircleTimes Integer 电话轮询次数 (取值范围1-5)
    注意:此字段可能返回 null,表示取不到有效值。
    PhoneInnerInterval Integer 单次轮询内拨打间隔 秒数 (取值范围60-900)
    注意:此字段可能返回 null,表示取不到有效值。
    PhoneCircleInterval Integer 两次轮询间隔 秒数(取值范围60-900)
    注意:此字段可能返回 null,表示取不到有效值。
    NeedPhoneArriveNotice Integer 是否需要触达通知 0=否 1=是
    注意:此字段可能返回 null,表示取不到有效值。
    目录