数据结构

最近更新时间: 2024-06-18 14:31:30

DescribeAbnormalObjectsEventObject

DescribeAbnormalObjects接口返回的产品事件告警异常对象

被如下接口引用:DescribeAbnormalObjects

名称 必选 允许NULL 类型 描述
Status Int64 告警状态
Content String 告警内容
InstanceId String 实例id
Dimensions String 维度组合,json字符串
AbnormalStatus String 告警状态,“abnormal”表示告警未恢复,“warning”表示告警已恢复
FirstOccurTime String 首次发生时间
LastOccurTime String 最后发生时间
UniqueId String 维度组合md5
GroupId Int64 策略组id
GroupName String 策略组名称
ProjectId Int64 项目id
ProductCName String 产品中文名称
ProductEName String 产品英文名称
EventEName String 事件英文名称
EventCName String 事件中文名称
EventId Int64 产品事件id
Region String 地域
EventUniqueId String 产品维度组合md5

DescribePolicyConditionListConfigManualCalcType

DescribePolicyConditionList.ConfigManual.CalcType

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
Keys Array of Int64 CalcType 取值
Need Bool 是否必须

ArgusDimensionOut

Argus维度字段

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id Uint64 Id
NamespaceId Uint64 namespace的Id
EnName String 英文名
CnName String 中文名
CreateUin String 创建人
CreateTime Uint64 创建的时间戳
UpdateUin String 更新人
UpdateTime Uint64 更新的时间戳

MetricObjectMeaning

指标数据的解释

被如下接口引用:DescribeBaseMetrics

名称 必选 允许NULL 类型 描述
En String 指标英文解释
Zh String 指标中文解释

StrategyData

StrategyData

被如下接口引用:DescribeCCMGroupViewStrategy、DescribeStrategys

名称 必选 允许NULL 类型 描述
Data Array of StrategyEntry 返回数据
TotalCount Int64 查询数据列表总数

UnifyDashboardMeta

dashboard列表元素信息

被如下接口引用:DescribeUnifyDashboards

名称 必选 允许NULL 类型 描述
UUID String dashboard uuid
IsStarred Bool 是否收藏
Title String dashboard名
IsDefault Bool 是否默认
Type String dashboard类型
LastVisitTime String 最近访问时间
CreatedAt String 创建时间
UpdatedAt String 更新时间
FolderUUID String 文件夹uuid
IsFolder Bool 是否文件夹
Order String 顺序

DescribeAppFlowConverterResponseDataPoint

DescribeAppFlowConverterResponseDataPoint

被如下接口引用:DescribeAppFlow

名称 必选 允许NULL 类型 描述
Value Float 数据值

DescribePolicyInfoByInstanceConditionsTemp

DescribePolicyInfoByInstanceConditionsTemp

被如下接口引用:DescribePolicyInfoByInstance

名称 必选 允许NULL 类型 描述
GroupID Int64 组ID
GroupName String 组名
ViewName String 视图名
Remark String 备注
LastEditUin Int64 最后编辑者UIN
IsUnionRule Int64 是否为与关系
InsertTime Int64 创建时间
UpdateTime Int64 更新时间

AlarmPolicy

告警策略详情

被如下接口引用:DescribeAlarmPolicies、DescribeAlarmPolicy

名称 必选 允许NULL 类型 描述
PolicyId String 告警策略 ID
PolicyName String 告警策略名称
Remark String 备注信息
MonitorType String 监控类型 MT_QCE=云产品监控
Enable Int64 启停状态 0=停用 1=启用
UseSum Int64 策略组绑定的实例数
ProjectId Int64 项目 Id -1=无项目 0=默认项目
ProjectName String 项目名
Namespace String 告警策略类型
Measurement String 即 viewName / 视图 云产品监控为 cvm_device 等 自定义监控为 Namespace 下的 Measurement
PolicyExpression String 裸写包含触发规则、过滤条件等内容的告警规则,适用于 prometheus 监控
ConditionTemplateId String 触发条件模板 Id
Condition AlarmPolicyCondition 指标触发条件
EventCondition AlarmPolicyEventCondition 事件触发条件
NoticeIds Array of String 通知规则 id 列表
Notices Array of AlarmNotice 通知规则 列表
TriggerTasks Array of AlarmPolicyTriggerTask 触发任务列表
OriginID String 字段废弃:用于实例、实例组绑定和解绑接口(BindingPolicyObject、UnBindingAllPolicyObject、UnBindingPolicyObject)的策略 ID
ConditionsTemp ConditionsTemp 模板策略组注意:此字段可能返回 null,表示取不到有效值。
LastEditUin String 最后编辑的用户uin
UpdateTime Int64 更新时间注意:此字段可能返回 null,表示取不到有效值。
InsertTime Int64 创建时间注意:此字段可能返回 null,表示取不到有效值。
Region Array of String 地域
NamespaceShowName String namespace显示名字
IsDefault Int64 是否默认策略,1是,0否
CanSetDefault Int64 能否设置默认策略,1是,0否
InstanceGroupId Int64 实例分组ID
InstanceSum Int64 实例分组总实例数
InstanceGroupName String 实例分组名称
JsConfig String JsConfig 前台配置
RuleType String 触发条件类型 STATIC=静态阈值 DYNAMIC=动态类型
OriginId String 用于实例、实例组绑定和解绑接口(BindingPolicyObject、UnBindingAllPolicyObject、UnBindingPolicyObject)的策略 ID
TagInstances Array of TagInstance 标签
Filter String Filter
GroupBy String GroupBy

RegionPolicyObjectCount

DescribePolicyObjectCount接口返回的地域统计

被如下接口引用:DescribePolicyObjectCount

名称 必选 允许NULL 类型 描述
Region String 地域
Count Int64 绑定的实例数量

DescribePolicyInfoByInstanceGroupList

DescribePolicyInfoByInstanceGroupList

被如下接口引用:DescribePolicyInfoByInstance

名称 必选 允许NULL 类型 描述
GroupID Int64 策略组ID
GroupName String 策略名
IsOpen Bool 是否开启
ViewName String 视图名
LastEditUin Int64 最后编辑者UIN
IsDefault Int64 是否为默认策略
CanSetDefault Bool 是否能设为默认策略
ParentGroupID Int64 父策略组ID
Remark String 备注
IsUnionRule Int64 是否为与关系策略
ProjectID Int64 项目ID
Conditions Array of Condition 告警规则
ConditionsTemp DescribePolicyInfoByInstanceConditionsTemp 规则模板信息
InstanceGroup DescribePolicyInfoByInstanceInstanceGroup 实例组
NoShieldedSum Int64 未屏蔽实例数
UseSum Int64 实例总数
UpdateTime Int64 更新时间
InsertTime Int64 创建时间

IdcInfo

IdcInfo

被如下接口引用:DescribeIdcServerCount

名称 必选 允许NULL 类型 描述
IdcId Int64 地域ID
ServerCount Int64 实例数
IdcName String 地域名称

DescribeAgentStatusHistoryData

DescribeAgentStatusHistoryData

被如下接口引用:DescribeAgentStatusHistory

名称 必选 允许NULL 类型 描述
UnInstanceID String 实例ID
Status Int64 子机状态
Histories Array of DescribeAgentStatusHistory 历史数据

AlarmBindingInstance

AlarmBindingInstance

被如下接口引用:DescribeAlarmBindingInstanceList

名称 必选 允许NULL 类型 描述
UUID String 实例UUID
Information String 实例维度组合信息

CustomAlarmInfo

DescribeCustomAlarmList

被如下接口引用:

名称 必选 允许NULL 类型 描述
Caller String 调用方
LocalIP String IP
Msg String 消息内容
OccurTime String 发生时间

PCLMStatisticFilterRule

日志监控指标集配置 指标过滤条件

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
MetricItemId Int64 关联指标条目ID(只做出参,入参不填)
CreatedAt String 创建时间(只做出参,入参不填)
UpdatedAt String 更新时间(只做出参,入参不填)
Relation Int64 关系 1AND 2OR
Field String 字段名
Operator String 过滤操作符: 数字型字段支持:gt lt ge le eq ne in 字符型字段支持:eq ne in contains
Value String 过滤操作值

BindingPolicyObjectDimension

策略绑定实例维度信息

被如下接口引用:BindingPolicyObject、CreateInstanceGroup、DescribeInstanceGroup、ModifyInstanceGroup、ShieldPolicyAlarm

名称 必选 允许NULL 类型 描述
RegionId Int64 地域ID
Region String 地域名
Dimensions String 维度信息
EventDimensions String 事件维度信息

AlarmEvent

告警事件

被如下接口引用:DescribeAlarmEvents

名称 必选 允许NULL 类型 描述
EventName String 事件名
Description String 展示的事件名
Namespace String 告警策略类型
Tooltip MetricTooltip 可用于展示的提示信息

IdcInfoData

IdcInfoData

被如下接口引用:DescribeIdcServerCount

名称 必选 允许NULL 类型 描述
Data Array of IdcInfo 返回数据
TotalCount Int64 总数

ClmAnalysisFilter

CLM多维分析中的过滤条件

被如下接口引用:DescribeDimensionAnalysisData、DescribeMetricAnalysisData

名称 必选 允许NULL 类型 描述
Field String 字段名
Operator String 运算符 目前只支持 = (当value数组为多个值时为in关系)
Value Array of String

DescribePolicyQuotaV3ResponseData

DescribePolicyQuotaV3ResponseData

被如下接口引用:DescribePolicyQuota

名称 必选 允许NULL 类型 描述
ViewName String 视图
IsQuotaByProject Bool 是否为项目配额
QuotaList Array of DescribePolicyQuotaV3ResponseDataQuotaList 配额列表
Quota DescribePolicyQuotaV3ResponseDataQuota 配额

ArgusDimensionIn

Argus维度字段

被如下接口引用:

名称 必选 允许NULL 类型 描述
EnName String 英文名
CnName String 中文名

CgrpInstanceGroupNode

实例所在都分组数组

被如下接口引用:CreateInstances、DeleteInstances、DescribeInstance

名称 必选 允许NULL 类型 描述
Id Int64 分组Id
Name String 分组名称

DescribePolicyGroupInfoReceiverInfo

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

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

PCLMAlertFilterRule

CLM告警过滤条件

被如下接口引用:

名称 必选 允许NULL 类型 描述
AlertPolicyCID String 关联的告警策略CID
Key String 过滤的关键字
Operating String 操作符
Value String 筛选值(多个值逗号分隔)
CreatedAt String 创建时间
UpdatedAt String 更新时间

PolicyGroupReceiverInfo

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

被如下接口引用:DescribeConditionsTemplateList

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

TransLogInstanceGroupInfo

DescribeTransLog返回的InstanceGroupInfo

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id Int64 实例组Id
AppId Int64 AppId
GroupName String 实例组名
InstanceSum Int64 实例数量
CategoryType Int64 类型
ViewName String 视图名
CreateTime Int64 创建时间
LastModifyTime Int64 最近修改时间
LastEditUin String 最后修改UIN

DescribePolicyConditionListConfigManual

DescribePolicyConditionList.ConfigManual

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
CalcType DescribePolicyConditionListConfigManualCalcType 检测方式
CalcValue DescribePolicyConditionListConfigManualCalcValue 检测阈值
ContinueTime DescribePolicyConditionListConfigManualContinueTime 持续时间
Period DescribePolicyConditionListConfigManualPeriod 数据周期
PeriodNum DescribePolicyConditionListConfigManualPeriodNum 持续周期个数
StatType DescribePolicyConditionListConfigManualStatType 聚合方式

ArgusMetricIn

Argus指标字段

被如下接口引用:

名称 必选 允许NULL 类型 描述
EnName String 英文名
CnName String 中文名
AggType String 聚合方式
Unit String 单位
Category String 分类

DescribeBindingPolicyObjectListInstanceGroup

DescribeBindingPolicyObjectList返回的是实例分组信息

被如下接口引用:DescribeBindingPolicyObjectList

名称 必选 允许NULL 类型 描述
InstanceGroupId Int64 实例分组id
ViewName String 告警策略类型名称
LastEditUin String 最后编辑uin
GroupName String 实例分组名称
InstanceSum Int64 实例数量
UpdateTime Int64 更新时间
InsertTime Int64 创建时间
Regions Array of String 实例所在的地域集合

DimensionsDesc

维度信息

被如下接口引用:DescribeBaseMetrics

名称 必选 允许NULL 类型 描述
Dimensions Array of String 维度名数组

WebStorageInfos

dashboard弹窗信息管理

被如下接口引用:DescribeWebStorage

名称 必选 允许NULL 类型 描述
CreatedAt String 创建时间
SubUin String 子用户
Uin String 主用户
UpdatedAt String 更新时间
WebStorageInfo String 弹窗信息

ArgusOverviewNamespaceOut

Argus概览页的Namespace

被如下接口引用:

名称 必选 允许NULL 类型 描述
Namespace String Namespace的名称
Description String Namespace的描述
DataTimeLimit String 数据最大保存时间,单位天
DataDiskLimit String 数据最大存储容量,单位GB
DiskUsage String 已使用存储容量,单位GB

ProjectInfo

DescribeProjectsList接口出参

被如下接口引用:DescribeProjectsList

名称 必选 允许NULL 类型 描述
AppId Int64 AppId
CreatorUin Int64 创建人Uin
Name String 项目名
Info String 项目信息
IsDefault Int64 是否为默认
ProjectId Int64 项目Id
OwnerUin Int64 主账号Uin
SrcAppId Int64 源AppId
SrcPlat String 源平台
Status Int64 状态
CreateTime String 创建时间

DescribeSortObjectListDimension

DescribeSortObjectList接口的Dimension,表示维度,包括维度名和维度值

被如下接口引用:DescribeSortObjectList

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

PCLMMetricCustomItem

日志监控指标集复合指标配置

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
Formula String 表达式
Name String 指标名
Desc String 指标描述中文名
MetricSetCID String 指标集CID(只作出参,入参不填)
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)

DescribeInstanceGroupListInstanceGroup

DescribeInstanceGroupList接口返回的实例分组信息

被如下接口引用:DescribeInstanceGroupList

名称 必选 允许NULL 类型 描述
InstanceGroupId Int64 实例分组id
ViewName String 实例分组策略类型名称
LastEditUin String 最近更新人uin
GroupName String 实例分组名称
InstanceSum Int64 分组内的实例数
UpdateTime Int64 更新时间,unix时间戳
InsertTime Int64 创建时间,unix时间戳
PolicyGroups Array of DescribeInstanceGroupListPolicyGroup 绑定的告警策略组列表

CustomAlarmList

CustomAlarmList

被如下接口引用:DescribeCustomAlarmList

名称 必选 允许NULL 类型 描述
LocalIP String IP
Msg String 消息
OccurTime String 发生时间
Caller String 调用方

DashboardNamespace

Dashboard2.0数据源下命名空间信息

被如下接口引用:DescribeAllNamespaces、DescribeDashboardNamespaces

名称 必选 允许NULL 类型 描述
Id String 命名空间标示
Name String 命名空间名称
Value String 命名空间值
ProductName String 产品名称
Config String 配置信息
AvailableRegions Array of String 支持地域列表
SortId Int64 排序Id
Type String 命名空间类型
DashboardId String DashboardId

DescribePolicyGroupInfoEventCondition

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

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

CgrpInstance

新建实例Id

被如下接口引用:CreateInstances、DeleteInstances

名称 必选 允许NULL 类型 描述
InstanceId String 实例ID
InstanceName String 实例名称
TypeId String 类型
Region String 地域
ModuleId Int64 叶子分组节点

DescribeGraphDataPartition

DescribeGraphDataPartition

被如下接口引用:DescribeGraphData

名称 必选 允许NULL 类型 描述
Name Array of String 分区名
Usage Float 用量
Total Float 总量

StrategyEntryAlarm

StrategyEntryAlarm

被如下接口引用:CreateStrategy、DescribeCCMGroupViewStrategy、DescribeStrategys、ModifyStrategy

名称 必选 允许NULL 类型 描述
AlarmType Uint64 策略的告警规则类型。100:最大值(即>), 101:最大值(即>=),102:最小值告警(即 <), 103:最小值告警(即 <=),104:波动值告警
AttributeId Uint64 策略的告警规则属性ID
Threshold Int64 策略的告警规则阈值
DetectCount Int64 策略的告警规则DetectPeriod分钟内告警次数
DetectPeriod Int64 策略的告警周期
TriggerPeriod Int64 策略的告警规则告警间隔周期
Description String 描述
AttributeName String 指标中文描述
AttributeUniqueName String 指标英文描述,唯一名称

GroupTemplateList

GetRecommendedTemplateResponse.GroupTemplateList

被如下接口引用:DescribeRecommendedTemplate

名称 必选 允许NULL 类型 描述
GroupID Int64 模板策略組ID
GroupName String 模板策略组名称
IsDefault Int64 是否为默认策略
Enable Bool 告警策略启用状态
LastEditUin Int64 最后修改人UIN
NoShieldedInstanceCount Int64 未屏蔽的实例数
TotalInstanceCount Int64 总绑定实例数
ParentGroupID Int64 父策略组ID
Remark String 备注信息
ViewName String 视图
Conditions Array of Condition 指标告警触发条件
EventConditions Array of EventCondition 事件告警触发条件
CanSetDefault Bool 是否可设为默认告警策略
InsertTime Int64 创建时间
UpdateTime Int64 修改时间

ServerInfo

ServerInfo

被如下接口引用:DescribeServers

名称 必选 允许NULL 类型 描述
ServerId Uint64 服务器ID
ServerName String 服务器名称
Ip String 服务器内网IP
IdcId Int64 地域ID
IdcName String 地域名称

AttributeUnitInfoOutputData

AttributeUnitInfoOutputData

被如下接口引用:DescribeAttributeUnits

名称 必选 允许NULL 类型 描述
Data Array of AttributeUnitInfoOutput 属性单位数据列表
TotalCount Int64 属性单位数据列表个数

DescribeMonitorDataByAlarmIDDataPoint

DescribeMonitorDataByAlarmIDDataPoint

被如下接口引用:DescribeMonitorDataByAlarmID

名称 必选 允许NULL 类型 描述
IsNull Bool 是否为空
Value Float 数据值

ProductListForDescribeMonitorProducts

DescribeMonitorProducts 出参 ProductList 数组

被如下接口引用:

名称 必选 允许NULL 类型 描述
AvaliableRegions Array of String 支持的地域
Id String 产品的ID
IsShowInDashboard Bool 是否在Dashboard展示
Meta String JS配置
Namespace String 命名空间
PolicyViewName String 策略的视图名
ProductName String 产品名

CCMDashboardData

自定义监控 CCMDashboardData

被如下接口引用:

名称 必选 允许NULL 类型 描述
Data Array of CCMDashboardEntry 返回数据列表
TotalCount Int64 查询数据总数

PCLMAlertTriggerRule

CLM告警触发条件

被如下接口引用:

名称 必选 允许NULL 类型 描述
CreatedAt String 创建时间 (出参)
UpdatedAt String 更新时间(出参)
AlertPolicyCID String 关联的告警策略cid
MetricName String 指标名称(英文)
MetricType Int64 指标类型 1=普通指标 2=复合指标
Operating String 操作符
Value Float 指标阈值
ContinuousCycleCount Int64 持续周期个数
NoticeFrequencySec Int64 通知频率(通知间隔秒数)
MetricFormula String 复合指标表达式 (基础指标传空)

DescribeBaseMetricsForConsoleFontEndData

DescribeBaseMetricsForConsoleFontEndData

被如下接口引用:DescribeBaseMetricsForConsoleFontEnd

名称 必选 允许NULL 类型 描述
NameSpace String 名字空间
MetricName String 指标名
MetricCNName String 指标中文名
MetricENName String 指标英文名
Dimensions String 维度
Unit String 单位
UnitCNName String 单位中午名
PeriodAndStatTypes Array of DescribeBaseMetricsDataPeriod 周期与统计方式
Meaning Array of DescribeBaseMetricsDataMeaning 指标含义

ModifyConditionsTemplateRequestEventCondition

ModifyConditionsTemplateRequestEventCondition

被如下接口引用:CreateConditionsTemplate、ModifyConditionsTemplate

名称 必选 允许NULL 类型 描述
AlarmNotifyPeriod String 告警通知周期
AlarmNotifyType String 告警通知方式
EventID String 事件ID
RuleID Int64 规则ID

AttributeServerInfoOutputData

AttributeServerInfoOutputData

被如下接口引用:DescribeAttributeAllServer、DescribeIdcServer

名称 必选 允许NULL 类型 描述
Data Array of AttributeServerInfoOutput 返回上报该属性的服务器列表
TotalCount Int64 返回上报该属性的服务器列表个数

PCLMDescribeAlertPoliciesData

PCLMDescribeAlertPoliciesData

被如下接口引用:

名称 必选 允许NULL 类型 描述
TotalCount Int64 总数
AlertPolicies Array of PCLMAlertPolicy 列表元素

AlarmHistory

告警历史数据

被如下接口引用:DescribeAlarmHistories

名称 必选 允许NULL 类型 描述
AlarmId String 告警历史Id
MonitorType String 监控类型
Namespace String 策略类型
AlarmObject String 告警对象
Content String 告警内容
FirstOccurTime Int64 时间戳,首次出现时间
LastOccurTime Int64 时间戳,最后出现时间
AlarmStatus String 告警状态,ALARM=未恢复 OK=已恢复 NO_CONF=已失效 NO_DATA=数据不足
PolicyId String 告警策略 Id
PolicyName String 策略名称
VPC String 基础产品告警的告警对象所属网络
ProjectId Int64 项目 Id
ProjectName String 项目名字
InstanceGroup Array of InstanceGroups 告警对象所属实例组
ReceiverUids Array of Int64 接收人列表
ReceiverGroups Array of Int64 接收组列表
NoticeWays Array of String 告警渠道列表 SMS=短信 EMAIL=邮件 CALL=电话 WECHAT=微信
OriginId String 兼容告警1.0策略组 Id
AlarmType String 告警类型
EventId Int64 事件Id
Region String 地域
PolicyExists Int64 策略是否存在 0=不存在 1=存在
ExtraTags String 额外信息,json格式的字符串
MetricsInfo Array of AlarmHistoryMetric 指标信息
Dimensions String Dimensions

StrategyIdInfo

StrategyIdInfo

被如下接口引用:CreateStrategy

名称 必选 允许NULL 类型 描述
StrategyId Int64 告警策略ID

DescribeProductEventListDimensions

DescribeProductEventList的入参Dimensions

被如下接口引用:DescribeProductEventList

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

Dimension

实例对象的维度组合

被如下接口引用:DescribeDashboardMetricData、DescribePolicyGroupCount、GetMonitorData、GetTkeData

名称 必选 允许NULL 类型 描述
Name String 实例维度名称
Value String 实例维度值

ReceiverInfo

接收人信息

被如下接口引用:ModifyAlarmReceivers

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

Dimensions

实例对象的维度组合

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String 实例维度名称
Value String 实例维度值

TransLogInstance

DescribeTransLog返回的实例List

被如下接口引用:DescribeInstanceGroup

名称 必选 允许NULL 类型 描述
Dimensions String 实例Dimension
UniqueId String 实例UniqueID
IsShielded Int64 屏蔽状态,1表示已屏蔽,0表示未屏蔽
Region String 地域

CustomMetisAbnormOutput

智能异常检测结果数组

被如下接口引用:

名称 必选 允许NULL 类型 描述
ViewAttrAbnormals Array of CustomMetisAbnormOutputView 视图结果

AlarmPolicyRule

告警策略触发条件

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

名称 必选 允许NULL 类型 描述
MetricName String 指标名
AggregationDimensions Array of String 聚合维度列表
Period Int64 秒数 统计周期
AggregateType String 数据聚合类型 因复合条件可能涉及多个指标 这里用 json 表示 {"report_metric_gauge":"last"}
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=正则匹配
Value String 阈值
ContinuePeriod Int64 周期数 持续通知周期 1=持续1个周期 2=持续2个周期...
NoticeFrequency Int64 秒数 告警间隔 0=不重复 300=每5分钟告警一次 600=每10分钟告警一次 900=每15分钟告警一次 1800=每30分钟告警一次 3600=每1小时告警一次 7200=每2小时告警一次 10800=每3小时告警一次 21600=每6小时告警一次 43200=每12小时告警一次 86400=每1天告警一次
IsPowerNotice Int64 告警频率是否指数增长 0=否 1=是
Filter AlarmPolicyFilter 对于单个触发规则的过滤条件
Description String 指标展示名,用于出参
Unit String 单位,用于出参
RuleType String 触发条件类型 STATIC=静态阈值 DYNAMIC=动态阈值
ValueMax String ValueMax
ValueMin String ValueMin

ClmMetricAnalysisBasicMetric

CLM指标分析中的基础指标参数

被如下接口引用:DescribeMetricAnalysisData

名称 必选 允许NULL 类型 描述
Operator String 操作符
Name String 指标名

ClmMetricCustomItem

日志监控指标集复合指标配置

被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet

名称 必选 允许NULL 类型 描述
Formula String 表达式
Name String 指标名
Desc String 指标描述中文名
Id Int64 条目ID(只作出参,入参不填)
MetricSetId Int64 指标集ID(只作出参,入参不填)
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)

PCLMMetricBasicItem

日志监控指标集基础指标配置

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
Field String 字段名
Operator String 指标统计方法:sum count min max
Name String 指标名
Desc String 指标描述中文名
StatisticFilterRules Array of PCLMStatisticFilterRule 指标过滤规则
MetricSetCID String 指标集CID(只作出参,入参不填)
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)

AlarmNotice

告警通知模板详情

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

名称 必选 允许NULL 类型 描述
Id String 告警通知模板 ID
Name String 告警通知模板名称
UpdatedAt String 上次修改时间
UpdatedBy String 上次修改人
NoticeType String 告警通知类型 ALARM=未恢复通知 OK=已恢复通知 ALL=全部通知
UserNotices Array of UserNotice 用户通知列表
URLNotices Array of URLNotice 回调通知列表
IsPreset Int64 是否是系统预设通知模板 0=否 1=是
NoticeLanguage String 通知语言 zh-CN=中文 en-US=英文
PolicyIds Array of String 告警通知模板绑定的告警策略ID列表
AMPConsumerId String 后台 amp consumer id
ExtraChannels Array of String 其他非公开通知渠道
BigCustomerNotices Array of BigCustomerNotice BigCustomerNotices

MetricTooltip

指标的富文本提示语

被如下接口引用:DescribeAlarmEvents、DescribeAlarmHistories、DescribeAlarmMetrics

名称 必选 允许NULL 类型 描述
Message String 文本内容
URL String 详情链接
UrlName String 链接名称

ServerInfoData

ServerInfoData

被如下接口引用:DescribeServers

名称 必选 允许NULL 类型 描述
Data Array of ServerInfo 返回数据
TotalCount Int64 总数

DescribeAccidentConfigAccidentTypeInfo

DescribeAccidentConfig接口的事件类型

被如下接口引用:DescribeAccidentConfig

名称 必选 允许NULL 类型 描述
AccidentId Int64 平台事件id
AccidentName String 平台事件名称
AccidentEnName String 平台事件英文名称

DescribeBaseMetricsDataMeaning

DescribeBaseMetricsDataMeaning

被如下接口引用:DescribeBaseMetricsForConsoleFontEnd

名称 必选 允许NULL 类型 描述
Language String 语言
Meaning String 含义

DescribePolicyConditionListConfigManualCalcValue

DescribePolicyConditionList.ConfigManual.CalcValue

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
Default String 默认值
Fixed String 固定值
Max String 最大值
Min String 最小值
Need Bool 是否必须

ArgusMapOut

Argus通用Map

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String 名称
Values Array of String 值列表

DescribePolicyConditionListConfigManualPeriodNum

DescribePolicyConditionList.ConfigManual.PeriodNum

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
Default Int64 默认周期数
Keys Array of Int64 可选周期数
Need Bool 是否必须

DescribeAccidentConfigAccident

DescribeAccidentConfig接口的平台事件

被如下接口引用:DescribeAccidentConfig

名称 必选 允许NULL 类型 描述
BusinessId Int64 业务id
BusinessName String 业务名称
BusinessEnName String 业务英文名称
PolicyShowName String 策略展示名称
PolicyShowEnName String 策略展示英文名称
PolicyViewName String 策略类型名称
AccidentTypeInfo Array of DescribeAccidentConfigAccidentTypeInfo 平台事件类型列表

InstanceGroup

DescribeBasicAlarmList返回的Alarms里的InstanceGroup

被如下接口引用:DescribeBasicAlarmList

名称 必选 允许NULL 类型 描述
InstanceGroupId Int64 实例组ID
InstanceGroupName String 实例组名

CCMInstanceAttributeDataOutput

CCMInstanceAttributeDataOutput

被如下接口引用:DescribeCCMInstanceDatas

名称 必选 允许NULL 类型 描述
AttributeId Uint64 指标ID
ServerId Uint64 服务器ID
Values Array of AttributeTimestampValueOutput 指标上报数据
InstanceName String 实例名称

ArgusAggType

Argus聚合方式

被如下接口引用:

名称 必选 允许NULL 类型 描述
AggType String 聚合方式
Description String 描述

MetricDatum

指标名称和值的封装

被如下接口引用:PutMonitorData

名称 必选 允许NULL 类型 描述
MetricName String 指标名称
Value Uint64 指标的值

AlarmPolicyBasic

告警2.0告警策略基本信息

被如下接口引用:DescribeAlarmPoliciesBasic

名称 必选 允许NULL 类型 描述
MonitorType String 监控类型
OriginId String 告警策略1.0 Id
PolicyId String 告警策略2.0 Id
PolicyName String 告警策略名称

CvmAgentStatus

DescribeCvmAgentStatus接口返回的agent状态

被如下接口引用:DescribeCvmAgentStatus

名称 必选 允许NULL 类型 描述
InstanceId String 实例ID
AgentInstalled Bool Agent是否安装

CgrpModuleNode

分组叶子节点数据结构

被如下接口引用:CreateModule、DeleteModule、DescribeModule、ModifyModule

名称 必选 允许NULL 类型 描述
AppId Int64 AppId
High Int64 分组树高度
Id Int64 叶子分组Id
L1Id Int64 第一层分组Id
L1Name String 第一层分组名称
L2Id Int64 第二层分组Id
L2Name String 第二层分组名称
L3Id Int64 第三层分组Id
L3Name String 第三层分组名称
Name String 叶子分组名称
OwnerBack String 备份负责人
OwnerMain String 主要负责人
ParentId Int64 父分组Id
SubUin String SubUin
TypeId String 叶子分组允许添加的实例类型
Uin String Uin

AttributeValueInfoOutput

AttributeValueInfoOutput

被如下接口引用:DescribeServerData、DescribeViewData

名称 必选 允许NULL 类型 描述
Values Array of AttributeTimestampValueOutput 属性值列表
StartTime String 开始时间
EndTime String 结束时间
StartPosition Int64 开始位置
EndPosition Int64 结束位置

ClmMetricBasicItem

日志监控指标集基础指标配置

被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet

名称 必选 允许NULL 类型 描述
Field String 字段名
Operator String 指标统计方法:sum count min max
Name String 指标名
Desc String 指标描述中文名
StatisticFilterRules Array of ClmStatisticFilterRule 指标过滤规则
Id Int64 条目ID(只作出参,入参不填)
MetricSetId Int64 指标集ID(只作出参,入参不填)
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)

TransLogItem

DescribeTransLog返回的一条变更日志

被如下接口引用:DescribeTransLog

名称 必选 允许NULL 类型 描述
Id Int64 变更日志Id
ModuleId Int64 模块Id
LogData String 日志信息,json字符串
CreateTime Int64 创建时间
LastEditUin String 最后修改UIN

CgrpInstanceNode

分组实例详细

被如下接口引用:CreateInstances、DeleteInstances、DescribeInstance

名称 必选 允许NULL 类型 描述
Id String 自增Id
InstanceId String 实例Id
InstanceName String 实例名称
TypeId String 实例类型
Region String 地域
ModuleId Int64 叶子分组Id
ModuleName String 叶子分组名称
L1Id Int64 一级分组Id
L2Id Int64 二级分组Id
L3Id Int64 三级分组Id
AppId Int64 appId
Uin String Uin
SubUin String SubUin
Group Array of CgrpInstanceGroupNode 分组数组

ViewIdOutput

ViewIdOutput

被如下接口引用:

名称 必选 允许NULL 类型 描述
ViewId Uint64 视图ID

ConditionsTemp

告警条件模版

被如下接口引用:DescribeAlarmPolicies、DescribeAlarmPolicy

名称 必选 允许NULL 类型 描述
ConditionId Int64 告警条件id
TemplateName String 模版名称
Condition AlarmPolicyCondition 指标触发条件
EventCondition AlarmPolicyEventCondition 事件触发条件

StrategyStatesInfo

StrategyStatesInfo

被如下接口引用:ModifyStrategyStates

名称 必选 允许NULL 类型 描述
StrategyId Int64 告警策略ID
IsStart Int64 启停状态。默认为1。 0:停止中, 1:启动中

TagInstance

策略列表详情标签返回体

被如下接口引用:DescribeAlarmPolicies、DescribeAlarmPolicy

名称 必选 允许NULL 类型 描述
Key String 标签Key
Value String 标签Value
InstanceSum Int64 实例个数
ServiceType String 产品类型,如:cvm
RegionId String 地域ID
BindingStatus Int64 绑定状态,2:绑定成功,1:绑定中
TagStatus Int64 标签状态,2:标签存在,1:标签不存在

URLNotice

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

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

名称 必选 允许NULL 类型 描述
URL String 回调 url(限长256字符)
IsValid Int64 是否通过验证 0=否 1=是
ValidationCode String 验证码

DescribePolicyGroupListGroupInstanceGroup

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

被如下接口引用:DescribePolicyGroupList

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

CreatePolicyGroupEventCondition

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

被如下接口引用:CreatePolicyGroup

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

IdcData

IdcData

被如下接口引用:DescribeIdcTree

名称 必选 允许NULL 类型 描述
Id Int64 idc id,在腾讯云上代表zoneId
Name String idc id,在腾讯云上代表zone名称

BigCustomerNotice

大客户通知

被如下接口引用:CreateAlarmNotice、DescribeAlarmNotice、DescribeAlarmNotices、DescribeAlarmPolicies、DescribeAlarmPolicy

名称 必选 允许NULL 类型 描述
NeedPushChatGroup Int64 是否推送到大客户售后群 0=不推送 1=推送
StartTime Int64 通知开始时间 00:00:00 开始的秒数(取值范围0-86399)
EndTime String 通知结束时间 00:00:00 开始的秒数(取值范围0-86399)

DashboardMetricCondition

Dashboard2.0指标查询时的查询条件

被如下接口引用:DescribeDashboardMetricData

名称 必选 允许NULL 类型 描述
Dimension Array of String 数组元素为json序列化字符串
Region String 域名名称,如:ap-guangzhou

ModifyPolicyGroupEventCondition

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

被如下接口引用:ModifyPolicyGroup

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

MidQueryCondition

DescribeMidDimensionValueList的查询条件

被如下接口引用:DescribeMidDimensionValueList、DescribeStatisticData

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

TemplateTag

DescribeTemplateTags出参模板变量的标签列表

被如下接口引用:DescribeTemplateTags

名称 必选 允许NULL 类型 描述
Tag String 标签名
TagType String 标签类型
ProductId String 关联的产品ID(基础监控)

AttributeIdOutput

AttributeIdOutput

被如下接口引用:ModifyAttribute

名称 必选 允许NULL 类型 描述
AttributeId Uint64 属性ID

DashboardMetricData

Dashboard2.0 查询指标返回的上报数据

被如下接口引用:DescribeDashboardMetricData

名称 必选 允许NULL 类型 描述
MetricName String 指标名称
Aggregate String 聚合方式
GroupBy Array of Dimension 查询条件数组
Timestamps Array of Uint64 返回Timestamp数组
Value String 指标上报数据,返回json序列化字符串,数组形式
StartTime Datetime_iso 返回查询时间段的开始时间,使用ISO格式 如:2018-04-10T10:15:58.858Z
EndTime Datetime_iso 返回查询时间段的开始时间,使用ISO格式 如:2018-04-10T10:15:58.858Z
Period Int64 统计周期,单位为秒
Conditions Array of DashboardMetricCondition 过滤条件
Namespace String 命名空间
Error String 错误信息
Code String 错误码
SeriesId String 查询标识
ConfigId String 产品配置ID
Dimensions Array of Dimension 实例的维度组合
OrderTag Float 排序值
Type String 类型

DescribeAbnormalObjectsThresholdObject

DescribeAbnormalObjects接口返回的指标告警异常对象

被如下接口引用:DescribeAbnormalObjects

名称 必选 允许NULL 类型 描述
Id Int64 告警id
RuleId Int64 告警规则id
GroupId Int64 策略组id
GroupName String 策略组名称
ProjectId Int64 项目id
Status Int64 告警状态
Content String 告警内容
FirstOccurTime String 首次发生时间
LastOccurTime String 最后发生时间
Dimensions String 维度组合,json字符串
UniqueId String 维度组合md5
AbnormalStatus String 告警状态,“abnormal”表示告警未恢复,“warning”表示告警已恢复
InstanceId String 对象id

ClmStatisticFilterRule

日志监控指标集配置 指标过滤条件

被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet

名称 必选 允许NULL 类型 描述
Id Int64 条目ID(只做出参,入参不填)
MetricItemId Int64 关联指标条目ID(只做出参,入参不填)
CreatedAt String 创建时间(只做出参,入参不填)
UpdatedAt String 更新时间(只做出参,入参不填)
Relation Int64 关系 1AND 2OR
Field String 字段名
Operator String 过滤操作符: 数字型字段支持:gt lt ge le eq ne in 字符型字段支持:eq ne in contains
Value String 过滤操作值

Instance

实例维度组合数组

被如下接口引用:DescribePolicyGroupCount、GetMonitorData

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

PolicyGroupItem

DescribeInstanceGroup 返回的 PolicyGroups

被如下接口引用:DescribeInstanceGroup

名称 必选 允许NULL 类型 描述
GroupId Int64 策略Id
GroupName String 策略名

AttributeTimestampValueOutput

AttributeTimestampValueOutput

被如下接口引用:DescribeAttributeAggregateData、DescribeCCMInstanceDatas、DescribeServerData、DescribeServerDatas、DescribeViewData

名称 必选 允许NULL 类型 描述
Timestamp Int64 时间戳
Value Int64 属性值

InstanceGroupInfo

DescribeInstanceGroup接口返回的 InstanceGroupInfo 接口

被如下接口引用:DescribeInstanceGroup

名称 必选 允许NULL 类型 描述
GroupName String 实例组名
InstanceGroupId Int64 实例组ID
InstanceSum Int64 实例数量
ViewName String 视图名/策略类型
InsertTime Int64 创建时间
UpdateTime Int64 更新时间
LastEditUin String 最后更新UIN

CCMChartEntry

CCMChartEntry

被如下接口引用:DescribeCCMCharts

名称 必选 允许NULL 类型 描述
ChartId Int64 监控图表ID
ViewId Int64 分组视图ID
ChartName String 监控图表名称
ChartType Int64 监控图表类型。1 明细视图, 2 聚合视图
ProductType Int64 产品类型。1 基础监控, 2 自定义监控
AttributeId Int64 指标ID
Aggregation Int64 聚合方式。0 SUM, 1 AVG, 2 MAX, 3 MIN
Description String 描述
CreatorId Uint64 创建者ID
CreateTime String 创建时间
UpdaterId Uint64 更新者ID
UpdateTime String 更新时间
AttributeName String 指标名称
AttributeUniqueName String 指标唯一英文名称
UnitName String 指标单位名称

MonitorSelectedDimension

已选择维度

被如下接口引用:DescribeDashboardDimensionValues

名称 必选 允许NULL 类型 描述
DimensionName String 维度名
DimensionValue String 维度值

PolicyTag

策略标签

被如下接口引用:BindingPolicyTag、DescribeGroupIDByTags、UnbindingPolicyTag

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

DescribePolicyConditionListMetric

指标告警配置

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
ConfigManual DescribePolicyConditionListConfigManual 指标配置
MetricId Int64 指标id
MetricShowName String 指标名称
MetricUnit String 指标单位

DashboardMetricEntry

Dashboard2.0指标信息

被如下接口引用:DescribeDashboardMetrics

名称 必选 允许NULL 类型 描述
Namespace String 命名空间值
MetricName String 指标名称
MetricType String 指标类型
Aggregations Array of String 指标具有的聚合方式
Description String 指标展示名称
Unit String 指标数据单位
Min Float 最小值
Max Float 最大值
Dimensions Array of String 维度列表

ServerAttributeInfo

ServerAttributeInfo

被如下接口引用:

名称 必选 允许NULL 类型 描述
AttributeId Int64 指标ID
AttributeName String 指标名称
AttributeUniqueName String 指标唯一英文名称

DescribeAgentStatusHistory

DescribeAgentStatusHistory

被如下接口引用:DescribeAgentStatusHistory

名称 必选 允许NULL 类型 描述
Timestamp Datetime_iso 时间戳
Status Int64 状态

Point

监控数据点

被如下接口引用:

名称 必选 允许NULL 类型 描述
Timestamp Uint64 该监控数据点生成的时间点
Value Float 监控数据点的值

EventCondition

事件告警条件

被如下接口引用:DescribeConditionsTemplateList、DescribeRecommendedTemplate

名称 必选 允许NULL 类型 描述
AlarmNotifyPeriod String 告警通知频率
AlarmNotifyType String 重复通知策略预定义(0 - 只告警一次, 1 - 指数告警,2 - 连接告警)
EventID String 事件ID
EventDisplayName String 事件展示名称(对外)
RuleID String 规则ID

DashboardMetricQuery

Dashboard 2.0 指标查询入参结构体

被如下接口引用:DescribeDashboardMetricData

名称 必选 允许NULL 类型 描述
StartTime Datetime_iso 查询时间段的开始时间,使用ISO格式 如:2018-04-10T10:15:58.858Z
EndTime Datetime_iso 查询时间段的结束时间,使用ISO格式 如:2018-04-10T10:15:58.858Z
Datasource String 数据源
Namespace String 命名空间名称
MetricName String 查询指标名称
Period Int64 统计粒度,默认值为60,单位秒
GroupBy Array of String 分组,填写指标维度
Aggregate String 聚合方式,根据指标类型填写聚合方式
Conditions Array of DashboardMetricCondition 过滤条件
SeriesId String 查询标识
DataSourceRegion String 数据源地域名称
ConfigId String 产品配置ID
QueryVersion String 查询版本号,老版本不用传,新版本传"2020-10-21"
OrderBy String 排序值的计算方式,avg|sum|min|max
AscDesc String 排序顺序,asc|desc
Limit Uint64 排序个数

DescribePolicyGroupInfoCondition

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

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

ClmDescribeMetricSetsData

DescribeMetricSets 返回数据

被如下接口引用:DescribeMetricSets

名称 必选 允许NULL 类型 描述
MetricSets Array of ClmMetricSet 指标集列表数据
TotalCount Int64 总数

ModifyMsgPolicyVoiceConfig

自定义消息语音告警配置

被如下接口引用:CreateMsgPolicy、ModifyMsgPolicy

名称 必选 允许NULL 类型 描述
UidList Array of Int64 uid列表
RoundNumber Int64 告警轮数, 1到5之间
RoundInterval Int64 每轮告警之间的时间间隔, 单位秒
PersonInterval Int64 每个人之间的时间间隔, 单位秒
NeedSendNotice Int64 是否需要通知, 1表示需要, 0表示不需要

DescribeProductEventListEventsDimensions

DescribeProductEventList返回的Events的Dimensions

被如下接口引用:DescribeProductEventList

名称 必选 允许NULL 类型 描述
Key String 维度名(英文)
Name String 维度名(中文)
Value String 维度值

GroupIdTag

1.0策略ID、标签

被如下接口引用:DescribeGroupIDByTags

名称 必选 允许NULL 类型 描述
GroupIDList Array of String 1.0策略ID
Key String 标签Key
Value String 标签Value

PeriodsSt

周期内的统计方式

被如下接口引用:DescribeBaseMetrics

名称 必选 允许NULL 类型 描述
Period String 周期
StatType Array of String 统计方式

StrategyChannelInfo

StrategyChannelInfo

被如下接口引用:ModifyStrategyChannels

名称 必选 允许NULL 类型 描述
StrategyId Uint64 告警策略ID
AlarmChannel Array of String 告警渠道列表

AlarmHistoryMetric

告警历史的指标信息

被如下接口引用:DescribeAlarmHistories

名称 必选 允许NULL 类型 描述
QceNamespace String 查询数据使用的命名空间
MetricName String 指标名
Period Int64 统计周期
Value String 触发告警的数值
Tooltip MetricTooltip 指标的解释
Description String 指标的展示名

PCLMMetricAnalysisBasicMetric

CLM指标分析中的基础指标参数

被如下接口引用:

名称 必选 允许NULL 类型 描述
Operator String 操作符
Name String 指标名

DescribeEventPolicyConfig

DescribeEventPolicyConfig

被如下接口引用:DescribeEventPolicyConfig

名称 必选 允许NULL 类型 描述
EventID String 事件ID
ProductName String 产品名
ProductEName String 产品英文名
ProductCName String 产品中文名
EventName String 事件名
EventEName String 事件英文名
EventCName String 事件中文名
Dimensions Array of DescribeEventPolicyConfigDimension 维度

ModifyRecoverNotifyBatchNotifyInfo

ModifyRecoverNotifyBatch恢复方式信息

被如下接口引用:ModifyRecoverNotifyBatch

名称 必选 允许NULL 类型 描述
GroupId Int64 策略组id
RecoverNotify Array of String 告警恢复通知方式列表

CgrpGroupNode

CgrpGroupNode

被如下接口引用:CreateGroup、DeleteGroup、DescribeGroup、InitGroup、ModifyGroup

名称 必选 允许NULL 类型 描述
AppId Int64 组ID
High Int64 组深度
Id Int64 分组ID
IsLeaf Bool 是否是叶子节点
Level Int64 当前在树中的层级
Name String 树节点
ParentId Int64 父节点Id
SubUin String SubUin
TypeId String 允许叶子节点存放实例类型
Uin String Uin

MonitorProductInfo

DescribeMonitorProductByIds接口返回的产品信息

被如下接口引用:DescribeMonitorProductByIds

名称 必选 允许NULL 类型 描述
Id String 产品Id
ProductName String 产品名
PolicyViewName String 产品视图名
AvaliableRegions Array of String 支持的地域
IsShowInDashboard Bool Dashboard是否可见
Meta String 产品的详细信息,json字符串
Namespace String 产品的namespace

ProductSimple

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

被如下接口引用:DescribeProductList

名称 必选 允许NULL 类型 描述
Namespace String 命名空间
ProductName String 产品中文名称
ProductEnName String 产品英文名称

DescribeMonitorProductsProductMetaColumn

DescribeMonitorProducts.productList.meta.column

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String 名称
Keys String 关键字, json字符串, 可能是string数组或者string
EnName String 英文名称
IsShowInAlarmList Bool 是否在告警中展示
IsShowInMonitorList Bool 是否在产品列表中展示
IsShowInSelector Bool 是否在选择器中展示
RenderConditions String 前端渲染条件
Render String 前端渲染相关字段
NoWrap Bool 前端相关字段
Order Bool 前端相关字段, 是否进行排序
OrderField String 前端相关字段, 排序字段
Required Bool 是否必须
Postfixs String 后缀

ModifyConditionsTemplateRequestCondition

ModifyConditionsTemplateRequestCondition

被如下接口引用:CreateConditionsTemplate、ModifyConditionsTemplate

名称 必选 允许NULL 类型 描述
AlarmNotifyPeriod String 告警通知周期
AlarmNotifyType Int64 告警通知方式
CalcPeriod String 统计周期
CalcType String 统计方式
CalcValue String 统计值
ContinuePeriod String 持续周期
MetricId Int64 指标ID
RuleID Int64 规则ID

DescribeAlarmCallbackHistory

历史回调信息

被如下接口引用:DescribeAlarmCallbackHistory

名称 必选 允许NULL 类型 描述
Url String 回调地址
ValidFlag Int64 回调是否验证
VerifyCode String 回调地址验证码

ProductHealthStatus

DescribeProductHealthStatusList接口返回的HealthStatus

被如下接口引用:DescribeProductHealthStatusList

名称 必选 允许NULL 类型 描述
ViewName String 视图名
HealthStatus Int64 健康状态,1表示未恢复
WarningCount Int64 提醒的数量
AbnormalCount Int64 异常的数量
AlarmRegions Array of String 告警的地域列表

ClmMetricAnalysisCurrentData

CLM指标分析当前数据

被如下接口引用:

名称 必选 允许NULL 类型 描述
Current Array of PCLMMetricAnalysisPoint 当前数据

InstanceGroups

告警对象所属实例组

被如下接口引用:DescribeAlarmHistories

名称 必选 允许NULL 类型 描述
Id Int64 实例组 Id
Name String 实例组名称

Contact

DescribeContactList接口返回的接收人信息

被如下接口引用:DescribeContactList

名称 必选 允许NULL 类型 描述
Uid Int64 uid
Uin String uin
Name String 接收人名称
CanLogin Int64 是否可登录,0表示不可登录,1表示可登录
PhoneFlag Int64 手机号是否验证通过
PhoneNum String 手机号
EmailFlag Int64 邮箱是否验证通过
Email String 邮箱号
IsReceiverOwner Int64 是否是接收负责人
OwnerUid Int64 ownerUid

DescribeBaseMetricsDataPeriod

DescribeBaseMetricsDataPeriod

被如下接口引用:DescribeBaseMetricsForConsoleFontEnd

名称 必选 允许NULL 类型 描述
Period Uint64 周期
StatType Array of String 统计方式

MonitorTypeNamespace

策略类型

被如下接口引用:DescribeAlarmHistories

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

ArgusNamespaceOut

Argus的Namespace

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String 名称
Description String 描述
DataTimeLimit Uint64 数据最大保存时间,单位天
DataDiskLimit Uint64 数据最大存储容量,单位GB
AdminUins Array of String 管理员列表
AggPeriod Uint64 聚合周期
AppId Uint64 AppId
CreateUin String 创建人
CreateTime Uint64 创建的时间戳
UpdateUin String 更新人
UpdateTime Uint64 更新的时间戳
Id Uint64 Id

ClmAlertPolicy

已失效

被如下接口引用:CreateAlertPolicy、DescribeAlertPolicies、DescribeAlertPolicy、ModifyAlertPolicy

名称 必选 允许NULL 类型 描述
Name String 策略名称
MetricSetId Int64 指标集ID(无效参数)
Status Int64 状态 1=已开启 2=未开启
AlertGroupId String 告警接收组ID 逗号分隔
AlertChannel String 告警接收渠道 "SMS", "EMAIL", "WECHAT", "CALL" 多个逗号分隔
NoticePeriodBegin Int64 通知时段开始时间(从00:00:00开始计算的秒数)
NoticePeriodEnd Int64 通知时段结束时间(从00:00:00开始计算的秒数)
UrlScheme String 回调url的scheme
CallbackUrl String 回调url 不包含scheme部分
AlertFilterRules Array of ClmAlertFilterRule 告警过滤条件列表
AlertTriggerRules Array of ClmAlertTriggerRule 告警触发条件列表
Id Int64 告警策略ID (出参)
CreatedAt String 创建时间 (出参)
UpdatedAt String 更新时间 (出参)
AlertUserId String 告警接收人ID 逗号分隔
LatestAlertTime String 最近告警时间(出参)
FilterRelation Int64 过滤条件之间的关系 1与 2或
TriggerRelation Int64 触发条件之间的关系 1与 2或
MetricSetCID Float 指标集CID

ClmMetricSet

日志监控指标集

被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet

名称 必选 允许NULL 类型 描述
LogsetId String CLS日志集ID
LogsetName String CLS日志集名
LogtopicId String CLS日志主题ID
LogtopicName String CLS日志主题名
Name String 指标集名称
StatisticCycle Int64 统计周期 可选:60、300
TimeField String 时间字段
LogFilterRules Array of ClmLogFilterRule 日志过滤规则
MetricBasicItems Array of ClmMetricBasicItem 基础指标规则
MetricCustomItems Array of ClmMetricCustomItem 复合指标规则
Dimensions Array of ClmDimension 维度规则
Id Int64 条目ID(只作出参,入参不填)
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)
AppId Int64 APPID(只作出参,入参不填)
Uin String UIN(只作出参,入参不填)
Region String 地域(只作出参,入参不填)
LogProfileItems Array of ClmLogProfileItem 日志数据结构描述

DescribePolicyConditionListConfigManualPeriod

DescribePolicyConditionList.ConfigManual.Period

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
Default Int64 默认周期,单位:秒
Keys Array of Int64 可选周期,单位:秒
Need Bool 是否必须

PCLMDimension

日志监控指标集维度对象

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
Field String 字段名
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)
MetricSetCID String 指标集CID(只作出参,入参不填)

ClmDimension

日志监控指标集维度对象

被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet

名称 必选 允许NULL 类型 描述
Field String 字段名
Id Int64 条目ID(只作出参,入参不填)
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)
MetricSetId Int64 指标集ID(只作出参,入参不填)

ClmMetricAnalysisCompareData

CLM指标分析对比数据

被如下接口引用:

名称 必选 允许NULL 类型 描述
Compare Array of PCLMMetricAnalysisPoint 对比数据

ClmAlertFilterRule

已失效

被如下接口引用:CreateAlertPolicy、DescribeAlertPolicies、DescribeAlertPolicy、ModifyAlertPolicy

名称 必选 允许NULL 类型 描述
AlertPolicyId Int64 关联的告警策略ID
Key String 过滤的关键字
Operating String 操作符
Value String 筛选值(多个值逗号分隔)
Id Int64 过滤条件id
CreatedAt String 创建时间
UpdatedAt String 更新时间

ArgusMetricOut

Argus指标字段

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id Uint64 Id
NamespaceId Uint64 namespace的Id
EnName String 英文名
CnName String 中文名
AggType String 聚合方式
Unit String 单位
Category String 分类
CreateUin String 创建人
CreateTime Uint64 创建的时间戳
UpdateUin String 更新人
UpdateTime Uint64 更新的时间戳

DescribePolicyGroupListGroup

DescribePolicyGroupList.Group

被如下接口引用:DescribePolicyGroupList

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

CreatePolicyGroupCondition

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

被如下接口引用:CreatePolicyGroup

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

DataPoint

监控数据点

被如下接口引用:GetMonitorData

名称 必选 允许NULL 类型 描述
Dimensions Array of Dimension 实例对象维度组合
Timestamps Array of Float 时间戳数组,表示那些时间点有数据,缺失的时间戳,没有数据点,可以理解为掉点了
Values Array of Float 监控值数组,该数组和Timestamps一一对应

UserNotice

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

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

名称 必选 允许NULL 类型 描述
ReceiverType String 接收者类型 USER=用户 GROUP=用户组
UserIds Array of Int64 用户 uid 列表
GroupIds Array of Int64 用户组 group id 列表
StartTime Int64 通知开始时间 00:00:00 开始的秒数(取值范围0-86399)
EndTime Int64 通知结束时间 00:00:00 开始的秒数(取值范围0-86399)
NoticeWay Array of String 通知渠道列表 EMAIL=邮件 SMS=短信 CALL=电话 WECHAT=微信
PhoneOrder Array of Int64 电话轮询列表
PhoneCircleTimes Int64 电话轮询次数 (取值范围1-5)
PhoneInnerInterval Int64 单次轮询内拨打间隔 秒数 (取值范围60-900)
PhoneCircleInterval Int64 两次轮询间隔 秒数(取值范围60-900)
NeedPhoneArriveNotice Int64 是否需要触达通知 0=否 1=是

AlarmPolicyCondition

告警策略指标触发条件

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

名称 必选 允许NULL 类型 描述
IsUnionRule String 指标触发与或条件,0=或,1=与
Rules Array of AlarmPolicyRule 告警触发条件列表

MetricConfig

指标配置

被如下接口引用:DescribeAlarmMetrics

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

NameTypeBak

NameType

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String name

TemplateGroup

模板列表

被如下接口引用:DescribeConditionsTemplateList

名称 必选 允许NULL 类型 描述
Conditions Array of Condition 指标告警规则
EventConditions Array of EventCondition 事件告警规则
PolicyGroups Array of PolicyGroup 关联告警策略组
GroupID Int64 模板策略组ID
GroupName String 模板策略组名称
InsertTime Int64 创建时间
LastEditUin Int64 最后修改人UIN
Remark String 备注
UpdateTime Int64 更新时间
ViewName String 视图
IsUnionRule Int64 是否为与关系

ServerAttributeDataOutput

ServerAttributeDataOutput

被如下接口引用:DescribeServerDatas

名称 必选 允许NULL 类型 描述
AttributeId Uint64 指标ID
ServerId Uint64 服务器ID
Values Array of AttributeTimestampValueOutput 指标上报值

MetricAggregation

指标的聚合方式

被如下接口引用:DescribeAlarmMetrics

名称 必选 允许NULL 类型 描述
NameCn String 中文名
NameEn String 英文名
Id String Id
Name String Name

AttributeUnitInfoOutput

AttributeUnitInfoOutput

被如下接口引用:DescribeAttributeUnits

名称 必选 允许NULL 类型 描述
UnitId Uint64 指标单位ID
UnitName String 指标单位名称

PolicyGroup

策略组信息

被如下接口引用:DescribeConditionsTemplateList

名称 必选 允许NULL 类型 描述
CanSetDefault Bool 是否可设为默认告警策略
GroupID Int64 告警策略组ID
GroupName String 告警策略组名称
InsertTime Int64 创建时间
IsDefault Int64 是否为默认告警策略
Enable Bool 告警策略启用状态
LastEditUin Int64 最后修改人UIN
NoShieldedInstanceCount Int64 未屏蔽的实例数
ParentGroupID Int64 父策略组ID
ProjectID Int64 所属项目ID
ReceiverInfos Array of PolicyGroupReceiverInfo 告警接收对象信息
Remark String 备注信息
UpdateTime Int64 修改时间
TotalInstanceCount Int64 总绑定实例数
ViewName String 视图
IsUnionRule Int64 是否为与关系规则

Condition

告警条件

被如下接口引用:DescribeConditionsTemplateList、DescribePolicyInfoByInstance、DescribeRecommendedTemplate

名称 必选 允许NULL 类型 描述
AlarmNotifyPeriod Int64 告警通知频率
AlarmNotifyType Int64 重复通知策略预定义(0 - 只告警一次, 1 - 指数告警,2 - 连接告警)
CalcType String 检测方式
CalcValue String 检测值
ContinueTime String 持续时间
MetricID Int64 指标ID
MetricDisplayName String 指标展示名称(对外)
Period Int64 周期
RuleID Int64 规则ID
Unit String 指标单位

PCLMLogProfileItem

日志监控指标集-日志数据结构描述

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
MetricSetCID String 关联指标集CID(只做出参,入参不填)
Field String 字段名
Type String 字段类型,可选:string、long、double
CreatedAt String 创建时间(只做出参,入参不填)
UpdatedAt String 更新时间(只做出参,入参不填)

DescribeProductEventListEvents

DescribeProductEventList返回的Events

被如下接口引用:DescribeProductEventList

名称 必选 允许NULL 类型 描述
EventId Int64 事件ID
EventCName String 事件中文名
EventEName String 事件英文名
EventName String 事件简称
ProductCName String 产品中文名
ProductEName String 产品英文名
ProductName String 产品简称
InstanceId String 实例ID
InstanceName String 实例名称
ProjectId String 项目ID
Region String 地域
Status String 状态
SupportAlarm Int64 是否支持告警
Type String 事件类型
StartTime Int64 开始时间
UpdateTime Int64 更新时间
Dimensions Array of DescribeProductEventListEventsDimensions 实例对象信息
AdditionMsg Array of DescribeProductEventListEventsDimensions 实例对象附加信息
IsAlarmConfig Int64 是否配置告警
GroupInfo Array of DescribeProductEventListEventsGroupInfo 策略信息

DescribeBindingPolicyObjectListDimension

DescribeBindingPolicyObjectList接口的Dimension

被如下接口引用:DescribeBindingPolicyObjectList

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

HistoryAlarmInfo

DescribeAlarmHistoryByAlarmId接口返回参数

被如下接口引用:DescribeAlarmHistoryByAlarmId

名称 必选 允许NULL 类型 描述
Id Int64 告警Id
GroupId Int64 策略组Id
AlarmStatus String 告警状态
AlarmType Int64 告警类型,0(指标告警),2(产品事件告警),3(平台事件告警)
Content String 告警内容
CurrentValue String 当前值
FirstOccurTime String 首次触发时间
LastOccurTime String 最后触发时间
Duration Int64 持续时间
ObjId String 对象Id
ObjName String 对象名
ProjectId Int64 项目Id
ProjectName String 项目名
Region String 地域
Status Int64 状态,其中0表示未恢复,1表示已恢复,4表示已失效,2/3/5表示数据不足
ViewName String 视图名

DescribePolicyConditionListCondition

DescribePolicyConditionList策略条件

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
PolicyViewName String 策略视图名称
EventMetrics Array of DescribePolicyConditionListEventMetric 事件告警条件
IsSupportMultiRegion Bool 是否支持多地域
Metrics Array of DescribePolicyConditionListMetric 指标告警条件
Name String 策略类型名称
SortId Int64 排序id
SupportDefault Bool 是否支持默认策略
SupportRegions Array of String 支持该策略类型的地域列表
DeprecatingInfo String 过期信息

DescribeAlarmSmsQuotaQuota

DescribeAlarmSmsQuota接口的配额信息

被如下接口引用:DescribeAlarmSmsQuota

名称 必选 允许NULL 类型 描述
Type String 配额类型
Name String 配额名称
FreeLeft Int64 免费配额剩余量
PurchaseLeft Int64 付费配额剩余量
Used Int64 已使用量

MetricData

DescribeMetricData接口出参

被如下接口引用:DescribeDataForMiniProgram、DescribeStatisticData

名称 必选 允许NULL 类型 描述
MetricName String
Points String

AlarmPolicyFilter

告警策略过滤条件

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

名称 必选 允许NULL 类型 描述
Type String 过滤条件类型 DIMENSION=使用 Dimensions 做过滤
Expression String 裸写过滤表达式
Dimensions String AlarmPolicyDimension 二维数组序列化后的json字符串,一维数组之间互为或关系,一维数组内的元素互为与关系

CCMGroupViewEntry

CCMGroupViewEntry

被如下接口引用:DescribeCCMGroupView

名称 必选 允许NULL 类型 描述
ViewId Int64 分组视图ID
ViewName String 分组视图名称
IsAuto Int64 分组视图是否自动绑定指标。0:否,1:是

ClmMetricAnalysisCustomMetric

CLM指标分析中的复合指标参数

被如下接口引用:DescribeMetricAnalysisData

名称 必选 允许NULL 类型 描述
Name String 复合指标名
Formula String 运算表达式

DescribePolicyConditionListEventMetric

DescribePolicyConditionList.EventMetric

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
EventId Int64 事件id
EventShowName String 事件名称
NeedRecovered Bool 是否需要恢复
Type Int64 事件类型,预留字段,当前固定取值为2

DescribePolicyGroupInfoConditionTpl

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

名称 必选 允许NULL 类型 描述
GroupId Int64 策略组id
GroupName String 策略组名称
ViewName String 策略类型
Remark String 策略组说明
LastEditUin String 最后编辑的用户uin
UpdateTime Int64 更新时间
InsertTime Int64 创建时间
IsUnionRule Int64 是否且规则

DescribeProductEventListOverView

DescribeProductEventList返回的OverView对象

被如下接口引用:DescribeProductEventList

名称 必选 允许NULL 类型 描述
StatusChangeAmount Int64 状态变更的事件数量
UnConfigAlarmAmount Int64 告警状态未配置的事件数量
UnNormalEventAmount Int64 异常事件数量
UnRecoverAmount Int64 未恢复的事件数量

PCLMMetricAnalysisPoint

CLM指标分析数据点

被如下接口引用:DescribeMetricAnalysisData

名称 必选 允许NULL 类型 描述
Timestamp Int64 时间戳(秒)
Value Float
Name String 指标名

MonitorDimensionSource

维度Key Sources

被如下接口引用:DescribeDashboardDimensionKeys

名称 必选 允许NULL 类型 描述
Namespace String 命名空间
Metric String 指标
SearchValue String 搜索值

DescribePolicyConditionListConfigManualStatType

DescribePolicyConditionList.ConfigManual.StatType

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
P5 String 数据聚合方式,周期5秒
P10 String 数据聚合方式,周期10秒
P60 String 数据聚合方式,周期1分钟
P300 String 数据聚合方式,周期5分钟
P600 String 数据聚合方式,周期10分钟
P1800 String 数据聚合方式,周期30分钟
P3600 String 数据聚合方式,周期1小时
P86400 String 数据聚合方式,周期1天

AttributeAggrValueInfoOutputData

AttributeAggrValueInfoOutputData

被如下接口引用:DescribeAttributeAggregateData

名称 必选 允许NULL 类型 描述
Data Array of AttributeTimestampValueOutput 返回聚合数据列表
TotalCount Int64 返回聚合数据列表个数

DescribeEventPolicyConfigDimension

DescribeEventPolicyConfigDimension

被如下接口引用:DescribeEventPolicyConfig

名称 必选 允许NULL 类型 描述
Name String 维度名称
Key String 维度key值

PCLMAnalysisFilter

CLM多维分析中的过滤条件

被如下接口引用:

名称 必选 允许NULL 类型 描述
Field String 字段名
Operator String 运算符 目前只支持 = (当value数组为多个值时为in关系)
Value Array of String

MetricSet

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

被如下接口引用:DescribeBaseMetrics

名称 必选 允许NULL 类型 描述
Namespace String 命名空间,每个云产品会有一个命名空间
MetricName String 指标名称
Unit String 指标使用的单位
UnitCname String 指标使用的单位
Period Array of Int64 指标支持的统计周期,单位是秒,如60、300
Periods Array of PeriodsSt 统计周期内指标方式
Meaning MetricObjectMeaning 统计指标含义解释
Dimensions Array of DimensionsDesc 维度描述信息

ServiceInfo

ServiceInfo

被如下接口引用:CreateService、DescribeService

名称 必选 允许NULL 类型 描述
ServiceId Int64 服务ID
IsOpen Int64 是否开通服务
ViewId Int64 默认视图ID

DescribeStorageDurationData

DescribeStorageDurationData

被如下接口引用:DescribeStorageDuration

名称 必选 允许NULL 类型 描述
Period Int64 周期
Duration Int64 持续时间

MessagePolicy

MessagePolicy

被如下接口引用:DescribeMsgPolicyList

名称 必选 允许NULL 类型 描述
PolicyID String 策略ID
PolicyName String 策略名
ReceiverGroupIds Array of Int64 接收组ID列表
NotifyWay Array of String 通知方式
VoiceConfig DescribeMsgPolicyListVoiceConfig 语音配置
IsDefault Bool 是否为默认策略
AlarmCount Int64 告警次数

AlarmPolicyEventCondition

告警策略事件触发条件

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

名称 必选 允许NULL 类型 描述
Rules Array of AlarmPolicyRule 告警触发条件列表

DescribeBasicAlarmListAlarms

DescribeBasicAlarmList返回的Alarms

被如下接口引用:DescribeBasicAlarmList

名称 必选 允许NULL 类型 描述
Id Uint64 该条告警的ID
ProjectId Int64 项目ID
ProjectName String 项目名称
Status Int64 告警状态ID
AlarmStatus String 告警状态
GroupId Int64 策略组ID
GroupName String 策略组名
FirstOccurTime String 发生时间
Duration Int64 持续时间,单位s
LastOccurTime String 结束时间
Content String 告警内容
ObjName String 告警对象
ObjId String 告警对象ID
ViewName String 策略类型
Vpc String VPC,只有CVM有
MetricId Int64 指标ID
MetricName String 指标名
AlarmType Int64 告警类型,0表示指标告警,2表示产品事件告警,3表示平台事件告警
Region String 地域
Dimensions String 告警对象维度信息
NotifyWay Array of String 通知方式
InstanceGroup Array of InstanceGroup 所属实例组信息

DescribeMonitorProductsProductMetaAlarm

DescribeMonitorProducts.productList.meta.alarm

被如下接口引用:

名称 必选 允许NULL 类型 描述
Dimensions String 指标告警维度
EventDimensions String 事件告警维度
PolicyViewName String 告警策略视图名称

AttributeIdDeleteOutput

AttributeIdDeleteOutput

被如下接口引用:DeleteAttribute、DeleteAttributes

名称 必选 允许NULL 类型 描述
DeleteCount Int64 删除个数
AttributeId Array of Uint64 属性ID

CustomMetisAbnormOutputAttr

自定义监控智能检测检测结果Attr

被如下接口引用:

名称 必选 允许NULL 类型 描述
AttrId Uint64 自定义监控属性ID
Abnormals Array of Uint64 异常点

DescribeMsgPolicyListVoiceConfig

DescribeMsgPolicyListVoiceConfig

被如下接口引用:DescribeMsgPolicyInfo、DescribeMsgPolicyList

名称 必选 允许NULL 类型 描述
RoundNumber Int64 呼叫次数
UIDList Array of Int64 UIN列表
RoundInterval Int64 每轮间隔
PersonInterval Int64 没人间隔
NeedSendNotice Int64 是否需要发送提醒

DescribePolicySituationAlarmSituation

DescribePolicySituationAlarmSituation

被如下接口引用:DescribePolicySituation

名称 必选 允许NULL 类型 描述
AlarmRuleCount Int64 告警规则数
AlarmTouchCount Int64 告警触达数

PCLMMetricAnalysisData

Clm指标分析data结构

被如下接口引用:DescribeMetricAnalysisData

名称 必选 允许NULL 类型 描述
Compare Array of PCLMMetricAnalysisPoint 对比数据
Current Array of PCLMMetricAnalysisPoint 当前数据
Granularity Int64 时间粒度 (秒)

AlarmPolicyTriggerTask

告警策略触发任务

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

名称 必选 允许NULL 类型 描述
Type String 触发任务类型 AS=弹性伸缩
TaskConfig String 用 json 表示配置信息 {"Key1":"Value1","Key2":"Value2"}

DescribeDashboardViewList

DescribeDashboardViewList

被如下接口引用:DescribeDashboardViews

名称 必选 允许NULL 类型 描述
ViewID Int64 视图ID
DescName String 描述名
Namespace String 名字空间
MetricName Array of String 指标名列表
Meta String 元数据json
Instances Array of String 实例列表

DescribeProductEventListEventsGroupInfo

DescribeProductEventList返回的Events里的GroupInfo

被如下接口引用:DescribeProductEventList

名称 必选 允许NULL 类型 描述
GroupId Int64 策略ID
GroupName String 策略名

DashboardDimensionSource

Dashboard2.0维度列表

被如下接口引用:DescribeDashboardDimensionKeys

名称 必选 允许NULL 类型 描述
DataSource String 数据源
Namespace String 命名空间
DimensionName String 维度名
MetricName String 指标名称

ClmLogFilterRule

日志监控指标集过滤规则

被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet

名称 必选 允许NULL 类型 描述
Relation Int64 关系 1AND 2OR
Field String 字段名
Operator String 过滤操作符: 数字型字段支持:gt lt ge le eq ne in 字符型字段支持:eq ne in contains
Value String 过滤操作值
Id Int64 条目ID(只作出参,入参不填)
MetricSetId Int64 指标集ID(只作出参,入参不填)
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)

CustomMetisAbnormlInput

自定义监控智能检测

被如下接口引用:

名称 必选 允许NULL 类型 描述
ViewId Uint64 自定义监控视图ID
AttrId Array of Uint64 自定义监控属性ID

PCLMAlertPolicy

告警策略参数

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String 策略名称
MetricSetCID String 指标集CID
Status Int64 状态 1=已开启 2=未开启
AlertGroupId String 告警接收组ID 逗号分隔
AlertChannel String 告警接收渠道 "SMS", "EMAIL", "WECHAT", "CALL" 多个逗号分隔
NoticePeriodBegin Int64 通知时段开始时间(从00:00:00开始计算的秒数)
NoticePeriodEnd Int64 通知时段结束时间(从00:00:00开始计算的秒数)
UrlScheme String 回调url的scheme
CallbackUrl String 回调url 不包含scheme部分
AlertFilterRules Array of PCLMAlertFilterRule 告警过滤条件列表
AlertTriggerRules Array of PCLMAlertTriggerRule 告警触发条件列表
CID String 告警策略CID (出参)
CreatedAt String 创建时间 (出参)
UpdatedAt String 更新时间 (出参)
AlertUserId String 告警接收人ID 逗号分隔
LatestAlertTime String 最近告警时间(出参)
FilterRelation Int64 过滤条件之间的关系 1与 2或
TriggerRelation Int64 触发条件之间的关系 1与 2或

ClmModifyAlertPolicyStatusParam

ClmModifyAlertPolicyStatusParam 更新告警策略状态参数

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id Int64 告警策略ID
Status Int64 状态:1开启 2关闭

DashboardViewsInstances

DashboardViewsInstances

被如下接口引用:

名称 必选 允许NULL 类型 描述
RegionID String 地域ID
UnInstanceID String 实例ID

DashboardDataSource

Dashboard2.0 数据源信息

被如下接口引用:DescribeDashboardDataSources

名称 必选 允许NULL 类型 描述
UUID String DataSource 唯一标示
Name String 数据源名称
Type String 数据源类型,如MySQL,Prometheus
TypeLogoUrl String 数据源图标
Access String 访问 模式
Url String 数据源访问地址
Password String 密码,可以为空字符串
User String 用户名,可以为空字符串
Database String 数据库
BasicAuth Bool 默认为false
IsDefault Bool 是否为默认数据源
JsonData String 存储数据源的附加信息,如ES的链接信息"{ &#34;esVersion&#34;: 5, &#34;logLevelField&#34;: &#34;&#34;,&#34;logMessageField&#34;: &#34;&#34;, &#34;maxConcurrentShardRequests&#34;: 256, &#34;timeField&#34;: &#34;@timestamp&#34;}"
ReadOnly Bool 数据源数据是否只读

AttributeInfoOutputData

属性数据列表

被如下接口引用:DescribeAttributes

名称 必选 允许NULL 类型 描述
Data Array of AttributeInfoOutput 属性数据列表
TotalCount Int64 属性数据列表个数

CCMChartData

CCMChartData

被如下接口引用:DescribeCCMCharts

名称 必选 允许NULL 类型 描述
Data Array of CCMChartEntry 返回数据列表
TotalCount Int64 查询数据总数

ClmDescribeAlertPoliciesData

CLM告警策略列表返回结构

被如下接口引用:DescribeAlertPolicies

名称 必选 允许NULL 类型 描述
TotalCount Int64 总数
AlertPolicies Array of ClmAlertPolicy 列表元素

DescribeBindingPolicyObjectListInstance

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

被如下接口引用:DescribeBindingPolicyObjectList

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

ClmLogProfileItem

日志监控指标集-日志数据结构描述

被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet

名称 必选 允许NULL 类型 描述
Id Int64 id(只做出参,入参不填)
MetricSetId Int64 关联指标集ID(只做出参,入参不填)
Field String 字段名
Type String 字段类型,可选:string、long、double
CreatedAt String 创建时间(只做出参,入参不填)
UpdatedAt String 更新时间(只做出参,入参不填)

DescribePolicyQuotaV3ResponseDataQuota

DescribePolicyQuotaV3ResponseDataQuota

被如下接口引用:DescribePolicyQuota

名称 必选 允许NULL 类型 描述
Used Int64 用户
Total Int64 总数

SubscribeInfo

DescribeSubscribeInfo的出参

被如下接口引用:DescribeSubscribeInfo

名称 必选 允许NULL 类型 描述
BusinessId Int64 事件类型Id
BusinessName String 事件名
AccidentId Int64 问题类型Id
AccidentName String 问题名
NotifyWay Array of Int64 通知方式
Receivers Array of SubscribeInfoReceiver 接收人列表
Tips String 提示
UserConfig String 用户配置,json字符串

StrategyEntry

StrategyEntry

被如下接口引用:DescribeCCMGroupViewStrategy、DescribeStrategys

名称 必选 允许NULL 类型 描述
StrategyId Int64 告警策略ID
StrategyName String 告警策略名称
ReceiverType Int64 告警接受类型
ReceiverId Array of Uint64 告警接受用户或用户组ID列表
EffectiveStartTime String 有效开始时间
EffectiveEndTime String 有效结束时间
AlarmChannel Array of String 告警渠道列表。每个value可以为:"SMS","EMAIL","WECHAT"或"CALL"
CallbackUrl String 告警回调地址
Description String 描述
CreatorId Uint64 创建人ID
CreateTime String 创建时间
UpdaterId Uint64 更新人ID
UpdateTime String 更新时间
IsStart Int64 是否启动。 0:停止中, 1:启动中
MixType Uint64 告警对象类型。 1:服务器,2:视图
MixSubType Int64 告警对象子类型。MixType为2,则MixId为视图ID列表,MixId为空数组[], 则后台会自动查询默认视图ID;MixType为1(服务器)时,若MixSubType为1,MixId可不填;若MixSubType为2,则MixId为服务器ID列表,可含有多个服务器ID
Alarm Array of StrategyEntryAlarm 告警规则列表
MixId Array of Int64 告警对象类型ID列表。
Ip Array of String 若mixtype为服务器类型,且子类型为指定服务器id。则存在Ip列表

DescribeInstanceGroupListPolicyGroup

DescribeInstanceGroupList接口返回的策略组信息

被如下接口引用:DescribeInstanceGroupList

名称 必选 允许NULL 类型 描述
GroupId Int64 策略组id
GroupName String 策略组名称

AttributeInfoInput

属性信息

被如下接口引用:CreateAttributes

名称 必选 允许NULL 类型 描述
AttributeName String 属性名称
AttributeTypeId Uint64 属性类型
DataType Int64 属性数据类型
AttributeLevel Int64 属性级别
Unit Int64 属性单位
StatisticalPeriod Int64 统计周期
OwnerId Array of Uint64 负责人列表ID。默认为登录用户sub_uin
Description String 描述
AttributeUniqueName String 属性唯一名称。由字母、数字、横杠或下划线组成

AttributeServerInfoOutput

AttributeServerInfoOutput

被如下接口引用:DescribeAttributeAllServer、DescribeIdcServer

名称 必选 允许NULL 类型 描述
ServerId Uint64 服务器ID
ServerName String 服务器名称
Ip String 服务器ip
IdcId Int64 地域ID
IdcName String 地域名称

DescribePolicyInfoByInstanceInstanceGroup

DescribePolicyInfoByInstanceInstanceGroup

被如下接口引用:DescribePolicyInfoByInstance

名称 必选 允许NULL 类型 描述
InstanceGroupID Int64 实例组ID
ViewName String 视图
LastEditUin Int64 最后编辑者UIN
GroupName String 实例组名称
InstanceSum Int64 实例数
UpdateTime Int64 更新时间
InsertTime Int64 创建时间

AttributeValueInfoOutputData

AttributeValueInfoOutputData

被如下接口引用:DescribeServerData、DescribeViewData

名称 必选 允许NULL 类型 描述
Data Array of AttributeValueInfoOutput 属性上报数据列表
TotalCount Int64 属性数据列表个数个数

CustomMetisAbnormOutputView

自定义监控智能检测View

被如下接口引用:

名称 必选 允许NULL 类型 描述
ViewId Uint64 自定义监控视图ID
AttrAbnormals Array of CustomMetisAbnormOutputAttr 自定义监控智能检测结果View

DescribeDashboardsList

DescribeDashboardsList

被如下接口引用:DescribeDashboards

名称 必选 允许NULL 类型 描述
DashboardID String DashboardID
DescName String 描述名称
Meta String 元数据

DescribePolicyQuotaV3ResponseDataQuotaList

DescribePolicyQuotaV3ResponseDataQuotaList

被如下接口引用:DescribePolicyQuota

名称 必选 允许NULL 类型 描述
Used Int64 用户
Total Int64 总数
ProjectID Int64 项目ID

ModifyPolicyGroupCondition

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

被如下接口引用:ModifyPolicyGroup

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

PCLMDescribeMetricSetsData

CLMDescribeMetricSets 返回数据

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
MetricSets Array of PCLMMetricSet 指标集列表数据
TotalCount Int64 总数

AlarmPolicyQuota

告警2.0策略具体配额

被如下接口引用:DescribeAlarmObjectQuota、DescribeAlarmPolicyQuota

名称 必选 允许NULL 类型 描述
AppId Int64 账号ID
Namespace String 策略类型 ""=无策略类型
ProjectId Int64 项目 Id -1=无项目
Total Int64 配额总数
Used Int64 已使用量

PCLMDimensionAnalysisResultData

维度分析结果数据

被如下接口引用:DescribeDimensionAnalysisData

名称 必选 允许NULL 类型 描述
Current String 维度数据
Granularity Int64 粒度

DescribePolicyUseList

DescribePolicyUseList返回的对象

被如下接口引用:DescribePolicyUseList

名称 必选 允许NULL 类型 描述
UniqueId String 告警对象唯一id
Dimensions String 维度字符串

PCLMMetricAnalysisCustomMetric

CLM指标分析中的复合指标参数

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String 复合指标名
Formula String 运算表达式

AttributeInfoOutput

属性信息

被如下接口引用:DescribeAttributes、DescribeCCMGroupViewAttribute

名称 必选 允许NULL 类型 描述
AttributeId Uint64 属性ID
AttributeName String 属性名称
AttributeLevel Int64 属性级别
Description String 描述
AttributeType String 属性类型
DataType Int64 属性数据类型
CreateTime String 创建时间
OwnerName String 属性负责人
UnitId Int64 单位ID
UnitName String 单位名称
StatisticalPeriod Int64 统计周期
AttributeUniqueName String 属性唯一字符串,字母、数字、横杠或下划线组成

DashboardPanel

dashboard的panel

被如下接口引用:AddDashboardPanels、TopDashboardPanel

名称 必选 允许NULL 类型 描述
Type String copy|add
DashboardUUID String dashboard的UUID
PanelID Int64 panel的ID
Panel String panel数据

DescribeAccidentEventListAlarms

DescribeAccidentEventList接口的出参类型

被如下接口引用:DescribeAccidentEventList

名称 必选 允许NULL 类型 描述
BusinessTypeDesc String 事件分类
AccidentTypeDesc String 事件类型
BusinessID Int64 事件分类的ID,1表示服务问题,2表示其他订阅
EventStatus Int64 事件状态的ID,0表示已恢复,1表示未恢复
AffectResource String 影响的对象
Region String 事件的地域
OccurTime String 事件发生的时间
UpdateTime String 更新时间

ModifyNotifyBatchNotifyInfo

ModifyNotifyBatch接口的告警通知方式

被如下接口引用:ModifyNotifyBatch

名称 必选 允许NULL 类型 描述
GroupId Int64 策略组id
NotifyWay Array of String 告警方式列表

SubscribeInfoReceiver

DescribeSubscribeInfo出参

被如下接口引用:DescribeSubscribeInfo

名称 必选 允许NULL 类型 描述
Username String 用户名
Uin String 用户Uin
Uid String 用户Uid

CCMDashboardEntry

自定义监控 CCMDashboardEntry

被如下接口引用:

名称 必选 允许NULL 类型 描述
DashboardId Int64 自定义监控图表ID
DashboardName String 自定义监控图表名称
DashboardType Uint64 自定义监控图表类型。1 明细视图: , 2: 聚合视图
ProductType Uint64 产品类型。1 基础监控: , 2: 自定义监控
AttributeId Uint64 指标ID
Aggregation Array of Int64 聚合方式列表。列表元素:1 SUM, 2 AVG, 3 MAX, 4 MIN
Description String 描述
CreatorId Uint64 创建者ID
CreateTime String 创建时间
UpdaterId Uint64 更新者ID
UpdateTime String 更新时间
InstanceId Array of Int64 实例ID列表。

ClmAlertTriggerRule

废弃

被如下接口引用:CreateAlertPolicy、DescribeAlertPolicies、DescribeAlertPolicy、ModifyAlertPolicy

名称 必选 允许NULL 类型 描述
Id Int64 触发条件ID (出参)
CreatedAt String 创建时间 (出参)
UpdatedAt String 更新时间(出参)
AlertPolicyId Int64 关联的告警策略主键id
MetricName String 指标名称(英文)
MetricType Int64 指标类型 1=普通指标 2=复合指标
Operating String 操作符
Value Float 指标阈值
ContinuousCycleCount Int64 持续周期个数
NoticeFrequencySec Int64 通知频率(通知间隔秒数)
MetricFormula String 复合指标表达式 (基础指标传空)

MoveFailReason

移动dashboard失败原因

被如下接口引用:MoveUnifyDashboards

名称 必选 允许NULL 类型 描述
UUID String dashboard的uuid
Msg String 移动失败原因

DescribePolicyConditionListConfigManualContinueTime

DescribePolicyConditionList.ConfigManual.ContinueTime

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
Default Int64 默认持续时间,单位:秒
Keys Array of Int64 可选持续时间,单位:秒
Need Bool 是否必须

PCLMLogFilterRule

日志监控指标集过滤规则

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
Relation Int64 关系 1AND 2OR
Field String 字段名
Operator String 过滤操作符: 数字型字段支持:gt lt ge le eq ne in 字符型字段支持:eq ne in contains
Value String 过滤操作值
MetricSetCID String 指标集CID(只作出参,入参不填)
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)

PCLMMetricSet

日志监控指标集

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
LogsetId String CLS日志集ID
LogsetName String CLS日志集名
LogtopicId String CLS日志主题ID
LogtopicName String CLS日志主题名
Name String 指标集名称
StatisticCycle Int64 统计周期 可选:60、300
TimeField String 时间字段
LogFilterRules Array of PCLMLogFilterRule 日志过滤规则
MetricBasicItems Array of PCLMMetricBasicItem 基础指标规则
MetricCustomItems Array of PCLMMetricCustomItem 复合指标规则
Dimensions Array of PCLMDimension 维度规则
CID String CID(只作出参,入参不填)
CreatedAt String 创建时间(只作出参,入参不填)
UpdatedAt String 更新时间(只作出参,入参不填)
AppId Int64 APPID(只作出参,入参不填)
Uin String UIN(只作出参,入参不填)
Region String 地域(只作出参,入参不填)
LogProfileItems Array of PCLMLogProfileItem 日志数据结构描述
SubAccountUin String SubAccountUin(只作出参,入参不填)

CommonNamespace

统一的命名空间信息

被如下接口引用:DescribeAllNamespaces

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

DescribePolicyGroupInfoCallback

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

被如下接口引用:DescribePolicyGroupInfo

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

Metric

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

被如下接口引用:DescribeAlarmMetrics

名称 必选 允许NULL 类型 描述
Namespace String 告警策略类型
QceNamespace String 仅对云产品监控有效,用于某些接口查询数据
MetricName String 指标名
Description String 指标展示名
Aggregations Array of MetricAggregation 聚合方式
Min Float 最小值
Max Float 最大值
Dimensions Array of String 维度列表
Unit String 单位
Tooltip MetricTooltip 富文本提示语
MetricConfig MetricConfig 指标配置
Operators Array of String Operators
Periods Array of Int64 Periods