数据结构

最近更新时间: 2026-07-11 00:06:10

DescribePolicyConditionListConfigManualPeriodNum

DescribePolicyConditionList.ConfigManual.PeriodNum

被如下接口引用:DescribePolicyConditionList

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

DashboardMetricCondition

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

被如下接口引用:DescribeDashboardMetricData

名称 必选 允许NULL 类型 描述
Dimension Array of String 数组元素为json序列化字符串
示例值: {"unInstanceId":"ins-00jvv9mo"}
Region String 域名名称
示例值: gz

AttributeValueInfoOutput

AttributeValueInfoOutput

被如下接口引用:DescribeServerData、DescribeViewData

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

StrategyChannelInfo

StrategyChannelInfo

被如下接口引用:ModifyStrategyChannels

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

CCMGroupViewEntry

CCMGroupViewEntry

被如下接口引用:DescribeCCMGroupView

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

PCLMMetricAnalysisData

Clm指标分析data结构

被如下接口引用:DescribeMetricAnalysisData

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

CCMChartEntry

CCMChartEntry

被如下接口引用:DescribeCCMCharts

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

ModifyPolicyGroupCondition

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

被如下接口引用:ModifyPolicyGroup

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

PCLMLogProfileItem

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

被如下接口引用:CLMDescribeMetricSets

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

DescribePolicyConditionListConfigManualCalcType

DescribePolicyConditionList.ConfigManual.CalcType

被如下接口引用:DescribePolicyConditionList

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

AlarmPolicyQuota

告警2.0策略具体配额

被如下接口引用:DescribeAlarmObjectQuota、DescribeAlarmPolicyQuota

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

AlarmHistoryMetric

告警历史的指标信息

被如下接口引用:DescribeAlarmHistories、DescribeMiniDashboardAlarmInfo

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

DescribePolicyConditionListConfigManualContinueTime

DescribePolicyConditionList.ConfigManual.ContinueTime

被如下接口引用:DescribePolicyConditionList

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

IdcData

IdcData

被如下接口引用:DescribeIdcTree

名称 必选 允许NULL 类型 描述
Id Int64 idc id,在云平台上代表zoneId
示例值: 1
Name String idc id,在云平台上代表zone名称
示例值: 测试

CgrpGroupNode

CgrpGroupNode

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

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

DescribePolicyInfoByInstanceInstanceGroup

DescribePolicyInfoByInstanceInstanceGroup

被如下接口引用:DescribePolicyInfoByInstance

名称 必选 允许NULL 类型 描述
InstanceGroupID Int64 实例组ID
示例值: 1234
ViewName String 视图
示例值: cvm_device
LastEditUin Int64 最后编辑者UIN
示例值: 123456
GroupName String 实例组名称
示例值: 测试
InstanceSum Int64 实例数
示例值: 10
UpdateTime Int64 更新时间
示例值: 1735095122
InsertTime Int64 创建时间
示例值: 1735095122

ServerAttributeDataOutput

ServerAttributeDataOutput

被如下接口引用:DescribeServerDatas

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

GroupTemplateList

GetRecommendedTemplateResponse.GroupTemplateList

被如下接口引用:DescribeRecommendedTemplate

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

ClmAlertPolicy

已失效

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

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

DescribeAgentStatusHistoryData

DescribeAgentStatusHistoryData

被如下接口引用:DescribeAgentStatusHistory

名称 必选 允许NULL 类型 描述
UnInstanceID String 实例ID
示例值: ins-00jvv9mo
Status Int64 子机状态
示例值: 1
Histories Array of DescribeAgentStatusHistory 历史数据
示例值:查看

CreatePolicyGroupCondition

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

被如下接口引用:CreatePolicyGroup

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

ModifyNotifyBatchNotifyInfo

ModifyNotifyBatch接口的告警通知方式

被如下接口引用:ModifyNotifyBatch

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

TemplateTag

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

被如下接口引用:DescribeTemplateTags

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

MetricAggregation

指标的聚合方式

被如下接口引用:DescribeAlarmMetrics

名称 必选 允许NULL 类型 描述
NameCn String 中文名
示例值: test
NameEn String 英文名
示例值: 测试
Id String Id
示例值: 1
Name String Name
示例值: 测试

Condition

告警条件

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

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

DashboardDataSource

Dashboard2.0 数据源信息

被如下接口引用:DescribeDashboardDataSources

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

PCLMMetricSet

日志监控指标集

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
LogsetId String CLS日志集ID
示例值: d5f10b84-def8-4e58-bab0-16ef567b1f22
LogsetName String CLS日志集名
示例值: 测试
LogtopicId String CLS日志主题ID
示例值: d4253323-7dfc-4b1b-8889-d82cef77375a
LogtopicName String CLS日志主题名
示例值: 测试
Name String 指标集名称
示例值: 测试
StatisticCycle Int64 统计周期 可选:60、300
示例值: 1
TimeField String 时间字段
示例值: 1314141
LogFilterRules Array of PCLMLogFilterRule 日志过滤规则
示例值:查看
MetricBasicItems Array of PCLMMetricBasicItem 基础指标规则
示例值:查看
MetricCustomItems Array of PCLMMetricCustomItem 复合指标规则
示例值:查看
Dimensions Array of PCLMDimension 维度规则
示例值:查看
CID String CID(只作出参,入参不填)
示例值: cid-xxx
CreatedAt String 创建时间(只作出参,入参不填)
示例值: qwer
UpdatedAt String 更新时间(只作出参,入参不填)
示例值: qwer
AppId Int64 APPID(只作出参,入参不填)
示例值: 1234
Uin String UIN(只作出参,入参不填)
示例值: 123456
Region String 地域(只作出参,入参不填)
示例值: gz
LogProfileItems Array of PCLMLogProfileItem 日志数据结构描述
示例值:查看
SubAccountUin String SubAccountUin(只作出参,入参不填)
示例值: 123456

DescribeProductEventListDimensions

DescribeProductEventList的入参Dimensions

被如下接口引用:DescribeProductEventList

名称 必选 允许NULL 类型 描述
Name String 维度名
示例值: 测试
Value String 维度值
示例值: XXXX

NoticeContentTmpl

查询自定义内容模版信息

被如下接口引用:DescribeNoticeContentTmpl

名称 必选 允许NULL 类型 描述
TmplID String 模版id
示例值: tmpl-xxx
TmplName String 模版名称
示例值: tmplName
MonitorType String 监控类型
示例值: MT_QCE
TmplContents NoticeContentTmplItem 内容模版详情
示例值:查看
TmplLanguage String 模板语言 en/zh
示例值: zh
CreateTime Int64 创建时间,Unix时间戳,秒
示例值: 1729655205
UpdateTime Int64 修改时间,Unix时间戳,秒
示例值: 1729655205
LastModifier String 最后修改人
示例值: tester-b
Creator String 创建人
示例值: tester-a
IsPreset Int64 是否是预设 0 非预设 1预设
示例值: 0

ClmMetricCustomItem

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

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

名称 必选 允许NULL 类型 描述
Formula String 表达式
示例值: {"cluster_name":"es-dnxsssss"}
Name String 指标名
示例值: 测试
Desc String 指标描述中文名
示例值: 测试
Id Int64 条目ID(只作出参,入参不填)
示例值: 1
MetricSetId Int64 指标集ID(只作出参,入参不填)
示例值: 12
CreatedAt String 创建时间(只作出参,入参不填)
示例值: eqeadfrqc
UpdatedAt String 更新时间(只作出参,入参不填)
示例值: eqeadfrqc

DescribePolicyGroupListGroup

DescribePolicyGroupList.Group

被如下接口引用:DescribePolicyGroupList

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

CustomCallbackNoticeTmpl

自定义通知内容模板元素

被如下接口引用:CreateNoticeContentTmpl、DescribeNoticeContentTmpl、ModifyNoticeContentTmpl

名称 必选 允许NULL 类型 描述
ContentTmpl String 告警通知内容模板
示例值: 告警通知模板
TitleTmpl String 告警通知主题模板
示例值: 标题

PCLMLogFilterRule

日志监控指标集过滤规则

被如下接口引用:CLMDescribeMetricSets

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

NoticeContentTmplItem

内容通知模板元素

被如下接口引用:CreateNoticeContentTmpl、DescribeNoticeContentTmpl、ModifyNoticeContentTmpl

名称 必选 允许NULL 类型 描述
CustomCallback Array of CustomCallbackTmplMatcher 自定义通知渠道配置
示例值:查看

PCLMMetricCustomItem

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

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
Formula String 表达式
示例值: {"cluster_name":"es-dnxsssss"}
Name String 指标名
示例值: 测试
Desc String 指标描述中文名
示例值: 测试
MetricSetCID String 指标集CID(只作出参,入参不填)
示例值: cid-xxx
CreatedAt String 创建时间(只作出参,入参不填)
示例值: qwer
UpdatedAt String 更新时间(只作出参,入参不填)
示例值: qwer

DescribeProductEventListOverView

DescribeProductEventList返回的OverView对象

被如下接口引用:DescribeProductEventList

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

NoticeContentTmplBindInfo

通知模版和内容模版的绑定info

被如下接口引用:DescribeAlarmPolicies、DescribeAlarmPolicy、ModifyAlarmPolicyNotice

名称 必选 允许NULL 类型 描述
ContentTmplID String 内容模版id
示例值: tmpl-xxx
NoticeID String 通知模版id
示例值: notice-xxx

DescribePolicyInfoByInstanceGroupList

DescribePolicyInfoByInstanceGroupList

被如下接口引用:DescribePolicyInfoByInstance

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

SubscribeInfoReceiver

DescribeSubscribeInfo出参

被如下接口引用:DescribeSubscribeInfo

名称 必选 允许NULL 类型 描述
Username String 用户名
示例值: test
Uin String 用户Uin
示例值: 123456
Uid String 用户Uid
示例值: 1234

DescribeAccidentConfigAccident

DescribeAccidentConfig接口的平台事件

被如下接口引用:DescribeAccidentConfig

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

AlarmPolicyEventCondition

告警策略事件触发条件

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

名称 必选 允许NULL 类型 描述
Rules Array of AlarmPolicyRule 告警触发条件列表
示例值:查看

ProjectInfo

DescribeProjectsList接口出参

被如下接口引用:DescribeProjectsList

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

ModifyConditionsTemplateRequestCondition

ModifyConditionsTemplateRequestCondition

被如下接口引用:CreateConditionsTemplate、ModifyConditionsTemplate

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

DescribeBasicAlarmListAlarms

DescribeBasicAlarmList返回的Alarms

被如下接口引用:DescribeBasicAlarmList

名称 必选 允许NULL 类型 描述
Id Uint64 该条告警的ID
示例值: 1
ProjectId Int64 项目ID
示例值: 1
ProjectName String 项目名称
示例值: 测试
Status Int64 告警状态ID
示例值: 1
AlarmStatus String 告警状态
示例值: ALARM
GroupId Int64 策略组ID
示例值: 1234
GroupName String 策略组名
示例值: 测试
FirstOccurTime String 发生时间
示例值: 1735095122
Duration Int64 持续时间,单位s
示例值: 10
LastOccurTime String 结束时间
示例值: 1735095122
Content String 告警内容
示例值: qwer
ObjName String 告警对象
示例值: 172.16.0.15#75904
ObjId String 告警对象ID
示例值: 0a523bfb-dd09-47e2-a85c-0b23455b0949
ViewName String 策略类型
示例值: cvm_device
Vpc String VPC,只有CVM有
示例值: qwer
MetricId Int64 指标ID
示例值: 10
MetricName String 指标名
示例值: CpuUsage
AlarmType Int64 告警类型,0表示指标告警,2表示产品事件告警,3表示平台事件告警
示例值: 1
Region String 地域
示例值: gz
Dimensions String 告警对象维度信息
示例值: {"unInstanceId":"ins-xxx"}
NotifyWay Array of String 通知方式
示例值: sms
InstanceGroup Array of InstanceGroup 所属实例组信息
示例值:查看

DescribeInstanceGroupListPolicyGroup

DescribeInstanceGroupList接口返回的策略组信息

被如下接口引用:DescribeInstanceGroupList

名称 必选 允许NULL 类型 描述
GroupId Int64 策略组id
示例值: 1234
GroupName String 策略组名称
示例值: 测试

ConditionsTemp

告警条件模版

被如下接口引用:DescribeAlarmPolicies、DescribeAlarmPolicy

名称 必选 允许NULL 类型 描述
ConditionId Int64 告警条件id
示例值: 1234
TemplateName String 模版名称
示例值: test
Condition AlarmPolicyCondition 指标触发条件
示例值:查看
EventCondition AlarmPolicyEventCondition 事件触发条件
示例值:查看

InstanceGroups

告警对象所属实例组

被如下接口引用:DescribeAlarmHistories、DescribeMiniDashboardAlarmInfo

名称 必选 允许NULL 类型 描述
Id Int64 实例组 Id
示例值: 1
Name String 实例组名称
示例值: 测试

AlarmBindingInstance

AlarmBindingInstance

被如下接口引用:DescribeAlarmBindingInstanceList

名称 必选 允许NULL 类型 描述
UUID String 实例UUID
示例值: u78haeoyaq8w8wbr
Information String 实例维度组合信息
示例值: {"appid":1251000011,"projectid":10,"vm_uuid":"9566dd15-fb0a-4515-9b87-09ad16d87884"}

DescribeAlarmCallbackHistory

历史回调信息

被如下接口引用:DescribeAlarmCallbackHistory

名称 必选 允许NULL 类型 描述
Url String 回调地址
示例值: http://test.com
ValidFlag Int64 回调是否验证
示例值: 1
VerifyCode String 回调地址验证码
示例值: 1131ad

MiniDashboardAlarmInfo

MiniDashboard AlarmInfo

被如下接口引用:DescribeMiniDashboardAlarmInfo

名称 必选 允许NULL 类型 描述
Dimension String 维度信息
示例值: {"name":"instanceId","value":"1"}
NoPolicy Bool 无告警策略
示例值: true
DefaultPolicyWithoutNotice String 没有通知规则的默认策略
示例值: policy-abcdef

DescribePolicyConditionListMetric

指标告警配置

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
ConfigManual DescribePolicyConditionListConfigManual 指标配置
示例值:查看
MetricId Int64 指标id
示例值: 10
MetricShowName String 指标名称
示例值: cvm_device
MetricUnit String 指标单位
示例值: %

PolicyGroupReceiverInfo

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

被如下接口引用:DescribeConditionsTemplateList

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

DashboardMetricQuery

Dashboard 2.0 指标查询入参结构体

被如下接口引用:DescribeDashboardMetricData

名称 必选 允许NULL 类型 描述
StartTime Datetime_iso 查询时间段的开始时间,使用ISO格式 如:2018-04-10T10:15:58.858Z
示例值: 2019-11-29T12:30:13+08:00
EndTime Datetime_iso 查询时间段的结束时间,使用ISO格式 如:2018-04-10T10:15:58.858Z
示例值: 2019-03-24T20:50:00+08:00
Datasource String 数据源
示例值: DS_QCEMetric
Namespace String 命名空间名称
示例值: QCE/CVM
MetricName String 查询指标名称
示例值: LanOuttraffic
Period Int64 统计粒度,默认值为60,单位秒
示例值: 60
GroupBy Array of String 分组,填写指标维度
示例值: LanOuttraffic
Aggregate String 聚合方式,根据指标类型填写聚合方式
示例值: min
Conditions Array of DashboardMetricCondition 过滤条件
示例值:查看
SeriesId String 查询标识
示例值: 1a6deff1-7991-4d82-a8c1-44b66e1c33f6
DataSourceRegion String 数据源地域名称
示例值: gz
ConfigId String 产品配置ID
示例值: cvm
QueryVersion String 查询版本号,老版本不用传,新版本传"2020-10-21"
示例值: 2020-10-21
OrderBy String 排序值的计算方式,avg
AscDesc String 排序顺序,asc
Limit Uint64 排序个数
示例值: 10

DescribeAppFlowConverterResponseDataPoint

DescribeAppFlowConverterResponseDataPoint

被如下接口引用:DescribeAppFlow

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

ModifyPolicyGroupEventCondition

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

被如下接口引用:ModifyPolicyGroup

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

InstanceGroupInfo

DescribeInstanceGroup接口返回的 InstanceGroupInfo 接口

被如下接口引用:DescribeInstanceGroup

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

MetricObjectMeaning

指标数据的解释

被如下接口引用:DescribeBaseMetrics

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

ClmLogFilterRule

日志监控指标集过滤规则

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

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

DescribeProductEventListEvents

DescribeProductEventList返回的Events

被如下接口引用:DescribeProductEventList

名称 必选 允许NULL 类型 描述
EventId Int64 事件ID
示例值: 111
EventCName String 事件中文名
示例值: ping不可达
EventEName String 事件英文名
示例值: ping_unreachable
EventName String 事件简称
示例值: ping_unreachable
ProductCName String 产品中文名
示例值: cvm
ProductEName String 产品英文名
示例值: cvm
ProductName String 产品简称
示例值: cvm
InstanceId String 实例ID
示例值: ins-3xdfd90
InstanceName String 实例名称
示例值: ins-3xdfd90
ProjectId String 项目ID
示例值: 123
Region String 地域
示例值: gz
Status String 状态
示例值: 1
SupportAlarm Int64 是否支持告警
示例值: 1
Type String 事件类型
示例值: 21
StartTime Int64 开始时间
示例值: 1611560738
UpdateTime Int64 更新时间
示例值: 1611560790
Dimensions Array of DescribeProductEventListEventsDimensions 实例对象信息
示例值:查看
AdditionMsg Array of DescribeProductEventListEventsDimensions 实例对象附加信息
示例值:查看
IsAlarmConfig Int64 是否配置告警
示例值: 1
GroupInfo Array of DescribeProductEventListEventsGroupInfo 策略信息
示例值:查看

PCLMMetricBasicItem

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

被如下接口引用:CLMDescribeMetricSets

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

MonitorTypeInfo

监控类型详细信息

被如下接口引用:DescribeMonitorTypes

名称 必选 允许NULL 类型 描述
Id String 监控类型ID
示例值: 19023
Name String 监控类型
示例值: MT_QCE
SortId Int64 排列顺序
示例值: 1

DescribeDashboardsList

DescribeDashboardsList

被如下接口引用:DescribeDashboards

名称 必选 允许NULL 类型 描述
DashboardID String DashboardID
示例值: eipv6
DescName String 描述名称
示例值: test
Meta String 元数据
示例值: {"aggregateType":"detail","aggregations":["Avg","Max","Min"],"chartTypes":["column"],"configId":"cvm","layout":{"h":"5","h2":"0","w":"4","x":"0","y":"0"},"timeAggregate":"last"}

AttributeUnitInfoOutputData

AttributeUnitInfoOutputData

被如下接口引用:DescribeAttributeUnits

名称 必选 允许NULL 类型 描述
Data Array of AttributeUnitInfoOutput 属性单位数据列表
示例值:查看
TotalCount Int64 属性单位数据列表个数
示例值: 10

ClmDimension

日志监控指标集维度对象

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

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

DescribeGraphDataPartition

DescribeGraphDataPartition

被如下接口引用:DescribeGraphData

名称 必选 允许NULL 类型 描述
Name Array of String 分区名
示例值: 测试
Usage Float 用量
示例值: 1234
Total Float 总量
示例值: 10

AttributeInfoInput

属性信息

被如下接口引用:CreateAttributes

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

MetricData

DescribeMetricData接口出参

被如下接口引用:DescribeDataForMiniProgram、DescribeStatisticData

名称 必选 允许NULL 类型 描述
MetricName String
示例值: CpuUsage
Points String
示例值: qwer

AlarmPolicyFilter

告警策略过滤条件

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

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

AttributeTimestampValueOutput

AttributeTimestampValueOutput

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

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

NoticeContentTmplBindPolicyCount

通知内容模板绑定告警策略数量

被如下接口引用:DescribeNoticeContentTmpl

名称 必选 允许NULL 类型 描述
NoticeContentTmplID String 通知内容模板ID
示例值: tmpl-xxx
BindCount Uint64 绑定告警策略数量
示例值: 1

AlarmHistory

告警历史数据

被如下接口引用:DescribeAlarmHistories、DescribeMiniDashboardAlarmInfo

名称 必选 允许NULL 类型 描述
AlarmId String 告警历史Id
示例值: 01e1f33f-b4ec-43db-8fd0-6f7e163e6ca5
MonitorType String 监控类型
示例值: MT_QCE
Namespace String 策略类型
示例值: cvm_device
AlarmObject String 告警对象
示例值: ins-abcdef
Content String 告警内容
示例值: CPU 使用率 > 80%
FirstOccurTime Int64 时间戳,首次出现时间
示例值: 1611700000
LastOccurTime Int64 时间戳,最后出现时间
示例值: 1611734567
AlarmStatus String 告警状态,ALARM=未恢复 OK=已恢复 NO_CONF=已失效 NO_DATA=数据不足
示例值: ALARM
PolicyId String 告警策略 Id
示例值: policy-abcdef
PolicyName String 策略名称
示例值: 云服务器告警策略
VPC String 基础产品告警的告警对象所属网络
示例值: 0
ProjectId Int64 项目 Id
示例值: 0
ProjectName String 项目名字
示例值: 默认项目
InstanceGroup Array of InstanceGroups 告警对象所属实例组
示例值:查看
ReceiverUids Array of Int64 接收人列表
示例值: [1234]
ReceiverGroups Array of Int64 接收组列表
示例值: [1234]
NoticeWays Array of String 告警渠道列表 SMS=短信 EMAIL=邮件 CALL=电话 WECHAT=微信
示例值: ["SMS"]
OriginId String 兼容告警1.0策略组 Id
示例值: 12345
AlarmType String 告警类型
示例值: METRIC
EventId Int64 事件Id
示例值: 0
Region String 地域
示例值: region1
PolicyExists Int64 策略是否存在 0=不存在 1=存在
示例值: 1
ExtraTags String 额外信息,json格式的字符串
示例值: {"cluster_name":"es-dnxsssss"}
MetricsInfo Array of AlarmHistoryMetric 指标信息
示例值:查看
Dimensions String Dimensions
示例值: {"cluster_name":"es-dnxsssss"}
AlarmLevel String 告警等级
示例值: Remind

PCLMMetricAnalysisPoint

CLM指标分析数据点

被如下接口引用:DescribeMetricAnalysisData

名称 必选 允许NULL 类型 描述
Timestamp Int64 时间戳(秒)
示例值: 1735129241
Value Float
示例值: 10
Name String 指标名
示例值: 测试

PolicyTag

策略标签

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

名称 必选 允许NULL 类型 描述
Key String 标签Key
示例值: qwer
Value String 标签Value
示例值: qwer

DescribePolicyConditionListEventMetric

DescribePolicyConditionList.EventMetric

被如下接口引用:DescribePolicyConditionList

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

ProductHealthStatus

DescribeProductHealthStatusList接口返回的HealthStatus

被如下接口引用:DescribeProductHealthStatusList

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

DashboardPanel

dashboard的panel

被如下接口引用:AddDashboardPanels、TopDashboardPanel

名称 必选 允许NULL 类型 描述
Type String copy
DashboardUUID String dashboard的UUID
示例值: u78haeoyaq8w8wbr
PanelID Int64 panel的ID
示例值: 1234
Panel String panel数据
示例值: qwer

DescribeSortObjectListDimension

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

被如下接口引用:DescribeSortObjectList

名称 必选 允许NULL 类型 描述
Name String 维度名
示例值: appid
Value String 维度值
示例值: 1

TransLogItem

DescribeTransLog返回的一条变更日志

被如下接口引用:DescribeTransLog

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

ClmAlertTriggerRule

废弃

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

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

DashboardNamespace

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

被如下接口引用:DescribeAllNamespaces、DescribeDashboardNamespaces

名称 必选 允许NULL 类型 描述
Id String 命名空间标示
示例值: dcchannel
Name String 命名空间名称
示例值: 专线接入-专用通道
Value String 命名空间值
示例值: QCE/DCX
ProductName String 产品名称
示例值: 专线接入-专用通道
Config String 配置信息
示例值: {}
AvailableRegions Array of String 支持地域列表
示例值: ["gz"]
SortId Int64 排序Id
示例值: 301
Type String 命名空间类型
示例值: BUSINESS
DashboardId String DashboardId
示例值: eipv6

UserNotice

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

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

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

AttributeAggrValueInfoOutputData

AttributeAggrValueInfoOutputData

被如下接口引用:DescribeAttributeAggregateData

名称 必选 允许NULL 类型 描述
Data Array of AttributeTimestampValueOutput 返回聚合数据列表
示例值:查看
TotalCount Int64 返回聚合数据列表个数
示例值: 10

HistoryAlarmInfo

DescribeAlarmHistoryByAlarmId接口返回参数

被如下接口引用:DescribeAlarmHistoryByAlarmId

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

CvmAgentStatus

DescribeCvmAgentStatus接口返回的agent状态

被如下接口引用:DescribeCvmAgentStatus

名称 必选 允许NULL 类型 描述
InstanceId String 实例ID
示例值: ins-00jvv9mo
AgentInstalled Bool Agent是否安装
示例值: false

PolicyGroupItem

DescribeInstanceGroup 返回的 PolicyGroups

被如下接口引用:DescribeInstanceGroup

名称 必选 允许NULL 类型 描述
GroupId Int64 策略Id
示例值: 1234
GroupName String 策略名
示例值: 测试

DescribePolicyQuotaV3ResponseData

DescribePolicyQuotaV3ResponseData

被如下接口引用:DescribePolicyQuota

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

DescribeMonitorDataByAlarmIDDataPoint

DescribeMonitorDataByAlarmIDDataPoint

被如下接口引用:DescribeMonitorDataByAlarmID

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

MetricSet

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

被如下接口引用:DescribeBaseMetrics

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

TransLogInstance

DescribeTransLog返回的实例List

被如下接口引用:DescribeInstanceGroup

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

DescribeAlarmSmsQuotaQuota

DescribeAlarmSmsQuota接口的配额信息

被如下接口引用:DescribeAlarmSmsQuota

名称 必选 允许NULL 类型 描述
Type String 配额类型
示例值: cloud_test
Name String 配额名称
示例值: 云拨测告警
FreeLeft Int64 免费配额剩余量
示例值: 100
PurchaseLeft Int64 付费配额剩余量
示例值: 200
Used Int64 已使用量
示例值: 100

DescribePolicyConditionListCondition

DescribePolicyConditionList策略条件

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
PolicyViewName String 策略视图名称
示例值: cvm_device
EventMetrics Array of DescribePolicyConditionListEventMetric 事件告警条件
示例值:查看
IsSupportMultiRegion Bool 是否支持多地域
示例值: true
Metrics Array of DescribePolicyConditionListMetric 指标告警条件
示例值:查看
Name String 策略类型名称
示例值: test
SortId Int64 排序id
示例值: 1
SupportDefault Bool 是否支持默认策略
示例值: true
SupportRegions Array of String 支持该策略类型的地域列表
示例值: ["gz"]
DeprecatingInfo String 过期信息
示例值: qwer

ModifyMsgPolicyVoiceConfig

自定义消息语音告警配置

被如下接口引用:CreateMsgPolicy、ModifyMsgPolicy

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

DescribePolicyQuotaV3ResponseDataQuotaList

DescribePolicyQuotaV3ResponseDataQuotaList

被如下接口引用:DescribePolicyQuota

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

AlarmPolicyTriggerTask

告警策略触发任务

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

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

ClmMetricAnalysisCustomMetric

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

被如下接口引用:DescribeMetricAnalysisData

名称 必选 允许NULL 类型 描述
Name String 复合指标名
示例值: 测试
Formula String 运算表达式
示例值: {"cluster_name":"es-dnxsssss"}

CustomAlarmList

CustomAlarmList

被如下接口引用:DescribeCustomAlarmList

名称 必选 允许NULL 类型 描述
LocalIP String IP
示例值: 127.0.0.1
Msg String 消息
示例值: ok
OccurTime String 发生时间
示例值: 1735041205
Caller String 调用方
示例值: remote

DescribeProductEventListEventsGroupInfo

DescribeProductEventList返回的Events里的GroupInfo

被如下接口引用:DescribeProductEventList

名称 必选 允许NULL 类型 描述
GroupId Int64 策略ID
示例值: 1234
GroupName String 策略名
示例值: 测试

DescribeMsgPolicyListVoiceConfig

DescribeMsgPolicyListVoiceConfig

被如下接口引用:DescribeMsgPolicyInfo、DescribeMsgPolicyList

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

DescribePolicyGroupInfoReceiverInfo

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

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

PCLMDescribeMetricSetsData

CLMDescribeMetricSets 返回数据

被如下接口引用:CLMDescribeMetricSets

名称 必选 允许NULL 类型 描述
MetricSets Array of PCLMMetricSet 指标集列表数据
示例值:查看
TotalCount Int64 总数
示例值: 10

AttributeInfoOutputData

属性数据列表

被如下接口引用:DescribeAttributes

名称 必选 允许NULL 类型 描述
Data Array of AttributeInfoOutput 属性数据列表
示例值:查看
TotalCount Int64 属性数据列表个数
示例值: 10

Metric

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

被如下接口引用:DescribeAlarmMetrics

名称 必选 允许NULL 类型 描述
Namespace String 告警策略类型
示例值: cvm_device
QceNamespace String 仅对云产品监控有效,用于某些接口查询数据
示例值: QCE/CVM
MetricName String 指标名
示例值: CpuUsage
Description String 指标展示名
示例值: CPU利用率
Aggregations Array of MetricAggregation 聚合方式
示例值:查看
Min Float 最小值
示例值: 0
Max Float 最大值
示例值: 100
Dimensions Array of String 维度列表
示例值: vm_uuid
Unit String 单位
示例值: %
Tooltip MetricTooltip 富文本提示语
示例值:查看
MetricConfig MetricConfig 指标配置
示例值:查看
Operators Array of String Operators
示例值: {"Id":"eq","Name":"="}
Periods Array of Int64 Periods
示例值: 5

DescribePolicyConditionListConfigManualPeriod

DescribePolicyConditionList.ConfigManual.Period

被如下接口引用:DescribePolicyConditionList

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

MetricDatum

指标名称和值的封装

被如下接口引用:PutMonitorData

名称 必选 允许NULL 类型 描述
MetricName String 指标名称
示例值: CpuUsage
Value Uint64 指标的值
示例值: 10

AlarmPolicyBasic

告警2.0告警策略基本信息

被如下接口引用:DescribeAlarmPoliciesBasic

名称 必选 允许NULL 类型 描述
MonitorType String 监控类型
示例值: MT_QCE
OriginId String 告警策略1.0 Id
示例值: 1234
PolicyId String 告警策略2.0 Id
示例值: policy-abc123
PolicyName String 告警策略名称
示例值: 测试

ClmDescribeMetricSetsData

DescribeMetricSets 返回数据

被如下接口引用:DescribeMetricSets

名称 必选 允许NULL 类型 描述
MetricSets Array of ClmMetricSet 指标集列表数据
示例值:查看
TotalCount Int64 总数
示例值: 10

DescribeInstanceGroupListInstanceGroup

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

被如下接口引用:DescribeInstanceGroupList

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

PolicyGroup

策略组信息

被如下接口引用:DescribeConditionsTemplateList

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

DescribeEventPolicyConfig

DescribeEventPolicyConfig

被如下接口引用:DescribeEventPolicyConfig

名称 必选 允许NULL 类型 描述
EventID String 事件ID
示例值: 1234
ProductName String 产品名
示例值: cvm
ProductEName String 产品英文名
示例值: cvm
ProductCName String 产品中文名
示例值: 孕妇服务器
EventName String 事件名
示例值: ReadOnly
EventEName String 事件英文名
示例值: ReadOnly
EventCName String 事件中文名
示例值: 磁盘只读
Dimensions Array of DescribeEventPolicyConfigDimension 维度
示例值:查看

MonitorProductInfo

DescribeMonitorProductByIds接口返回的产品信息

被如下接口引用:DescribeMonitorProductByIds

名称 必选 允许NULL 类型 描述
Id String 产品Id
示例值: 10
ProductName String 产品名
示例值: cvm_device
PolicyViewName String 产品视图名
示例值: cvm_device
AvaliableRegions Array of String 支持的地域
示例值: ["gz"]
IsShowInDashboard Bool Dashboard是否可见
示例值: false
Meta String 产品的详细信息,json字符串
示例值: qwer
Namespace String 产品的namespace
示例值: QCE/CVM

MessagePolicy

MessagePolicy

被如下接口引用:DescribeMsgPolicyList

名称 必选 允许NULL 类型 描述
PolicyID String 策略ID
示例值: policy-abc123
PolicyName String 策略名
示例值: 测试
ReceiverGroupIds Array of Int64 接收组ID列表
示例值: [1234]
NotifyWay Array of String 通知方式
示例值: sms
VoiceConfig DescribeMsgPolicyListVoiceConfig 语音配置
示例值:查看
IsDefault Bool 是否为默认策略
示例值: true
AlarmCount Int64 告警次数
示例值: 1

InstanceGroup

DescribeBasicAlarmList返回的Alarms里的InstanceGroup

被如下接口引用:DescribeBasicAlarmList

名称 必选 允许NULL 类型 描述
InstanceGroupId Int64 实例组ID
示例值: 1234
InstanceGroupName String 实例组名
示例值: 测试

DescribeAbnormalObjectsThresholdObject

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

被如下接口引用:DescribeAbnormalObjects

名称 必选 允许NULL 类型 描述
Id Int64 告警id
示例值: 1
RuleId Int64 告警规则id
示例值: 10
GroupId Int64 策略组id
示例值: 1234
GroupName String 策略组名称
示例值: 测试
ProjectId Int64 项目id
示例值: 1
Status Int64 告警状态
示例值: 1
Content String 告警内容
示例值: qwer
FirstOccurTime String 首次发生时间
示例值: 1735041205
LastOccurTime String 最后发生时间
示例值: 1735041205
Dimensions String 维度组合,json字符串
示例值: {"unInstanceId":"ins-xxx"}
UniqueId String 维度组合md5
示例值: eqeq-czda
AbnormalStatus String 告警状态,“abnormal”表示告警未恢复,“warning”表示告警已恢复
示例值: abnormal
InstanceId String 对象id
示例值: ins-00jvv9mo

StrategyStatesInfo

StrategyStatesInfo

被如下接口引用:ModifyStrategyStates

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

AlarmEvent

告警事件

被如下接口引用:DescribeAlarmEvents

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

DimensionsDesc

维度信息

被如下接口引用:DescribeBaseMetrics

名称 必选 允许NULL 类型 描述
Dimensions Array of String 维度名数组
示例值: ["vm_uuid"]

ServerInfo

ServerInfo

被如下接口引用:DescribeServers

名称 必选 允许NULL 类型 描述
ServerId Uint64 服务器ID
示例值: 1
ServerName String 服务器名称
示例值: qwer
Ip String 服务器内网IP
示例值: 127.0.0.1
IdcId Int64 地域ID
示例值: 10
IdcName String 地域名称
示例值: qwer

ModifyRecoverNotifyBatchNotifyInfo

ModifyRecoverNotifyBatch恢复方式信息

被如下接口引用:ModifyRecoverNotifyBatch

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

CgrpInstanceGroupNode

实例所在都分组数组

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

名称 必选 允许NULL 类型 描述
Id Int64 分组Id
示例值: 1
Name String 分组名称
示例值: test

AttributeIdOutput

AttributeIdOutput

被如下接口引用:ModifyAttribute

名称 必选 允许NULL 类型 描述
AttributeId Uint64 属性ID
示例值: 10

MetricConfig

指标配置

被如下接口引用:DescribeAlarmMetrics

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

ClmAlertFilterRule

已失效

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

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

DescribePolicyConditionListConfigManualCalcValue

DescribePolicyConditionList.ConfigManual.CalcValue

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
Default String 默认值
示例值: test
Fixed String 固定值
示例值: qwer
Max String 最大值
示例值: 100
Min String 最小值
示例值: 10
Need Bool 是否必须
示例值: true

DescribePolicyGroupInfoCallback

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

被如下接口引用:DescribePolicyGroupInfo

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

ProductSimple

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

被如下接口引用:DescribeProductList

名称 必选 允许NULL 类型 描述
Namespace String 命名空间
示例值: QCE/CVM
ProductName String 产品中文名称
示例值: cvm_device
ProductEnName String 产品英文名称
示例值: test

StrategyEntryAlarm

StrategyEntryAlarm

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

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

AttributeServerInfoOutput

AttributeServerInfoOutput

被如下接口引用:DescribeAttributeAllServer、DescribeIdcServer

名称 必选 允许NULL 类型 描述
ServerId Uint64 服务器ID
示例值: 1
ServerName String 服务器名称
示例值: test
Ip String 服务器ip
示例值: 127.0.0.1
IdcId Int64 地域ID
示例值: 1
IdcName String 地域名称
示例值: test

MoveFailReason

移动dashboard失败原因

被如下接口引用:MoveUnifyDashboards

名称 必选 允许NULL 类型 描述
UUID String dashboard的uuid
示例值: daaeqe
Msg String 移动失败原因
示例值: ok

StrategyData

StrategyData

被如下接口引用:DescribeCCMGroupViewStrategy、DescribeStrategys

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

MonitorSelectedDimension

已选择维度

被如下接口引用:DescribeDashboardDimensionValues

名称 必选 允许NULL 类型 描述
DimensionName String 维度名
示例值: 测试
DimensionValue String 维度值
示例值: 100

DescribePolicyUseList

DescribePolicyUseList返回的对象

被如下接口引用:DescribePolicyUseList

名称 必选 允许NULL 类型 描述
UniqueId String 告警对象唯一id
示例值: eqeq-czda
Dimensions String 维度字符串
示例值: {"unInstanceId":"ins-xxx"}

ClmDescribeAlertPoliciesData

CLM告警策略列表返回结构

被如下接口引用:DescribeAlertPolicies

名称 必选 允许NULL 类型 描述
TotalCount Int64 总数
示例值: 10
AlertPolicies Array of ClmAlertPolicy 列表元素
示例值:查看

DescribeDashboardViewList

DescribeDashboardViewList

被如下接口引用:DescribeDashboardViews

名称 必选 允许NULL 类型 描述
ViewID Int64 视图ID
示例值: 1
DescName String 描述名
示例值: 测试
Namespace String 名字空间
示例值: QCE/CVM
MetricName Array of String 指标名列表
示例值: CpuUsage
Meta String 元数据json
示例值: {"aggregateType":"detail","aggregations":["Avg","Max","Min"],"chartTypes":["column"],"configId":"cvm","layout":{"h":"5","h2":"0","w":"4","x":"0","y":"0"},"timeAggregate":"last"}
Instances Array of String 实例列表
示例值: ["ins-xxx"]

DescribePolicyConditionListConfigManual

DescribePolicyConditionList.ConfigManual

被如下接口引用:DescribePolicyConditionList

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

Dimension

实例对象的维度组合

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

名称 必选 允许NULL 类型 描述
Name String 实例维度名称
示例值: InstanceId
Value String 实例维度值
示例值: ins-c282wnl0

CustomCallbackTmplMatcher

自定义内容通知模板的匹配器

被如下接口引用:CreateNoticeContentTmpl、DescribeNoticeContentTmpl、ModifyNoticeContentTmpl

名称 必选 允许NULL 类型 描述
MatchingStatus Array of String 匹配状态 Invalid; Trigger ;Recovery
示例值: Trigger
Template CustomCallbackNoticeTmpl 模板配置
示例值:查看

DataPoint

监控数据点

被如下接口引用:GetMonitorData

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

AlarmPolicyRule

告警策略触发条件(指标和事件共用,示例值用/区分)

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

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

ClmStatisticFilterRule

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

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

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

DescribePolicyInfoByInstanceConditionsTemp

DescribePolicyInfoByInstanceConditionsTemp

被如下接口引用:DescribePolicyInfoByInstance

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

CCMInstanceAttributeDataOutput

CCMInstanceAttributeDataOutput

被如下接口引用:DescribeCCMInstanceDatas

名称 必选 允许NULL 类型 描述
AttributeId Uint64 指标ID
示例值: 1
ServerId Uint64 服务器ID
示例值: 1
Values Array of AttributeTimestampValueOutput 指标上报数据
示例值:查看
InstanceName String 实例名称
示例值: ins-qwer

DashboardDimensionSource

Dashboard2.0维度列表

被如下接口引用:DescribeDashboardDimensionKeys

名称 必选 允许NULL 类型 描述
DataSource String 数据源
示例值: DS_QCEMetric
Namespace String 命名空间
示例值: cvm_device
DimensionName String 维度名
示例值: 测试
MetricName String 指标名称
示例值: cpu_usage

DescribeBindingPolicyObjectListInstance

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

被如下接口引用:DescribeBindingPolicyObjectList

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

DescribeStorageDurationData

DescribeStorageDurationData

被如下接口引用:DescribeStorageDuration

名称 必选 允许NULL 类型 描述
Period Int64 周期
示例值: 5
Duration Int64 持续时间
示例值: 10

DescribePolicyGroupInfoCondition

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

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

ModifyConditionsTemplateRequestEventCondition

ModifyConditionsTemplateRequestEventCondition

被如下接口引用:CreateConditionsTemplate、ModifyConditionsTemplate

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

URLNotice

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

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

名称 必选 允许NULL 类型 描述
URL String 回调 url(限长256字符)
示例值: http://www.123.com
IsValid Int64 是否通过验证 0=否 1=是
示例值: 1
ValidationCode String 验证码
示例值: 82hf8t

PCLMDimension

日志监控指标集维度对象

被如下接口引用:CLMDescribeMetricSets

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

CreatePolicyGroupEventCondition

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

被如下接口引用:CreatePolicyGroup

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

PCLMDimensionAnalysisResultData

维度分析结果数据

被如下接口引用:DescribeDimensionAnalysisData

名称 必选 允许NULL 类型 描述
Current String 维度数据
示例值: qwer
Granularity Int64 粒度
示例值: 1

ClmMetricBasicItem

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

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

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

DescribePolicyGroupInfoEventCondition

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

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

CgrpModuleNode

分组叶子节点数据结构

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

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

RegionPolicyObjectCount

DescribePolicyObjectCount接口返回的地域统计

被如下接口引用:DescribePolicyObjectCount

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

TemplateGroup

模板列表

被如下接口引用:DescribeConditionsTemplateList

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

StrategyIdInfo

StrategyIdInfo

被如下接口引用:CreateStrategy

名称 必选 允许NULL 类型 描述
StrategyId Int64 告警策略ID
示例值: 1

TagInstance

策略列表详情标签返回体

被如下接口引用:DescribeAlarmPolicies、DescribeAlarmPolicy

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

AlarmNotice

告警通知模板详情

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

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

DescribeAccidentEventListAlarms

DescribeAccidentEventList接口的出参类型

被如下接口引用:DescribeAccidentEventList

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

PeriodsSt

周期内的统计方式

被如下接口引用:DescribeBaseMetrics

名称 必选 允许NULL 类型 描述
Period String 周期
示例值: 60
StatType Array of String 统计方式
示例值: avg

AttributeServerInfoOutputData

AttributeServerInfoOutputData

被如下接口引用:DescribeAttributeAllServer、DescribeIdcServer

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

ClmMetricAnalysisBasicMetric

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

被如下接口引用:DescribeMetricAnalysisData

名称 必选 允许NULL 类型 描述
Operator String 操作符
示例值: =
Name String 指标名
示例值: 测试

AttributeValueInfoOutputData

AttributeValueInfoOutputData

被如下接口引用:DescribeServerData、DescribeViewData

名称 必选 允许NULL 类型 描述
Data Array of AttributeValueInfoOutput 属性上报数据列表
示例值:查看
TotalCount Int64 属性数据列表个数个数
示例值: 10

DescribeAbnormalObjectsEventObject

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

被如下接口引用:DescribeAbnormalObjects

名称 必选 允许NULL 类型 描述
Status Int64 告警状态
示例值: 1
Content String 告警内容
示例值: qewrrq
InstanceId String 实例id
示例值: ins-00jvv9mo
Dimensions String 维度组合,json字符串
示例值: {"unInstanceId":"ins-xxx"}
AbnormalStatus String 告警状态,“abnormal”表示告警未恢复,“warning”表示告警已恢复
示例值: abnormal
FirstOccurTime String 首次发生时间
示例值: 1735041205
LastOccurTime String 最后发生时间
示例值: 1735041205
UniqueId String 维度组合md5
示例值: 1314edae41314
GroupId Int64 策略组id
示例值: 1234
GroupName String 策略组名称
示例值: 测试
ProjectId Int64 项目id
示例值: 1
ProductCName String 产品中文名称
示例值: 云服务器
ProductEName String 产品英文名称
示例值: cvm
EventEName String 事件英文名称
示例值: ReadOnly
EventCName String 事件中文名称
示例值: 磁盘只读
EventId Int64 产品事件id
示例值: 1
Region String 地域
示例值: gz
EventUniqueId String 产品维度组合md5
示例值: eqeq-czda

Contact

DescribeContactList接口返回的接收人信息

被如下接口引用:DescribeContactList

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

DescribeAgentStatusHistory

DescribeAgentStatusHistory

被如下接口引用:DescribeAgentStatusHistory

名称 必选 允许NULL 类型 描述
Timestamp Datetime_iso 时间戳
示例值: 2019-11-29T12:30:13+08:00
Status Int64 状态
示例值: 1

AttributeIdDeleteOutput

AttributeIdDeleteOutput

被如下接口引用:DeleteAttribute、DeleteAttributes

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

DescribePolicyGroupInfoConditionTpl

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

名称 必选 允许NULL 类型 描述
GroupId Int64 策略组id
示例值: 1234
GroupName String 策略组名称
示例值: 测试
ViewName String 策略类型
示例值: cvm_device
Remark String 策略组说明
示例值: test
LastEditUin String 最后编辑的用户uin
示例值: 123456
UpdateTime Int64 更新时间
示例值: 1735095122
InsertTime Int64 创建时间
示例值: 1735095122
IsUnionRule Int64 是否且规则
示例值: 1

EventCondition

事件告警条件

被如下接口引用:DescribeConditionsTemplateList、DescribeRecommendedTemplate

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

AttributeUnitInfoOutput

AttributeUnitInfoOutput

被如下接口引用:DescribeAttributeUnits

名称 必选 允许NULL 类型 描述
UnitId Uint64 指标单位ID
示例值: 1
UnitName String 指标单位名称
示例值: test

StrategyEntry

StrategyEntry

被如下接口引用:DescribeCCMGroupViewStrategy、DescribeStrategys

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

DescribeBaseMetricsDataMeaning

DescribeBaseMetricsDataMeaning

被如下接口引用:DescribeBaseMetricsForConsoleFontEnd

名称 必选 允许NULL 类型 描述
Language String 语言
示例值: zh
Meaning String 含义
示例值: qwer

DescribeBindingPolicyObjectListDimension

DescribeBindingPolicyObjectList接口的Dimension

被如下接口引用:DescribeBindingPolicyObjectList

名称 必选 允许NULL 类型 描述
RegionId Int64 地域id
示例值: 1
Region String 地域简称
示例值: gz
Dimensions String 维度组合json字符串
示例值: {"unInstanceId":"ins-xxx"}
EventDimensions String 事件维度组合json字符串
示例值: {"unInstanceId":"ins-xxx"}

DescribeBindingPolicyObjectListInstanceGroup

DescribeBindingPolicyObjectList返回的是实例分组信息

被如下接口引用:DescribeBindingPolicyObjectList

名称 必选 允许NULL 类型 描述
InstanceGroupId Int64 实例分组id
示例值: 1234
ViewName String 告警策略类型名称
示例值: cvm_device
LastEditUin String 最后编辑uin
示例值: 123456
GroupName String 实例分组名称
示例值: 测试
InstanceSum Int64 实例数量
示例值: 10
UpdateTime Int64 更新时间
示例值: 1735095122
InsertTime Int64 创建时间
示例值: 1735095122
Regions Array of String 实例所在的地域集合
示例值: ["gz"]

DescribeEventPolicyConfigDimension

DescribeEventPolicyConfigDimension

被如下接口引用:DescribeEventPolicyConfig

名称 必选 允许NULL 类型 描述
Name String 维度名称
示例值: 测试
Key String 维度key值
示例值: qwer

MonitorTypeNamespace

策略类型

被如下接口引用:DescribeAlarmHistories

名称 必选 允许NULL 类型 描述
MonitorType String 监控类型
示例值: MT_QCE
Namespace String 策略类型值
示例值: cvm_device

DashboardMetricData

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

被如下接口引用:DescribeDashboardMetricData

名称 必选 允许NULL 类型 描述
MetricName String 指标名称
示例值: CpuUsage
Aggregate String 聚合方式
示例值: avg
GroupBy Array of Dimension 查询条件数组
示例值:查看
Timestamps Array of Uint64 返回Timestamp数组
示例值: [1604303550]
Value String 指标上报数据,返回json序列化字符串,数组形式
示例值: [1,0.8]
StartTime Datetime_iso 返回查询时间段的开始时间,使用ISO格式 如:2018-04-10T10:15:58.858Z
示例值: 2019-11-29T12:30:13+08:00
EndTime Datetime_iso 返回查询时间段的开始时间,使用ISO格式 如:2018-04-10T10:15:58.858Z
示例值: 2019-03-24T20:50:00+08:00
Period Int64 统计周期,单位为秒
示例值: 60
Conditions Array of DashboardMetricCondition 过滤条件
示例值:查看
Namespace String 命名空间
示例值: QCE/CVM
Error String 错误信息
示例值: error
Code String 错误码
示例值: 11001
SeriesId String 查询标识
示例值: 1a6deff1-7991-4d82-a8c1-44b66e1c33f6
ConfigId String 产品配置ID
示例值: qwer
Dimensions Array of Dimension 实例的维度组合
示例值:查看
OrderTag Float 排序值
示例值: 1234
Type String 类型
示例值: qwer

Instance

实例维度组合数组

被如下接口引用:DescribePolicyGroupCount、GetMonitorData

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

MidQueryCondition

DescribeMidDimensionValueList的查询条件

被如下接口引用:DescribeMidDimensionValueList、DescribeStatisticData

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

MonitorDimensionSource

维度Key Sources

被如下接口引用:DescribeDashboardDimensionKeys

名称 必选 允许NULL 类型 描述
Namespace String 命名空间
示例值: QCE/CVM
Metric String 指标
示例值: CpuUsage
SearchValue String 搜索值
示例值: qwer

GroupIdTag

1.0策略ID、标签

被如下接口引用:DescribeGroupIDByTags

名称 必选 允许NULL 类型 描述
GroupIDList Array of String 1.0策略ID
示例值: ["123456"]
Key String 标签Key
示例值: qwer
Value String 标签Value
示例值: qwer

ServerInfoData

ServerInfoData

被如下接口引用:DescribeServers

名称 必选 允许NULL 类型 描述
Data Array of ServerInfo 返回数据
示例值:查看
TotalCount Int64 总数
示例值: 10

ReceiverInfo

接收人信息

被如下接口引用:ModifyAlarmReceivers

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

ServiceInfo

ServiceInfo

被如下接口引用:CreateService、DescribeService

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

CommonNamespace

统一的命名空间信息

被如下接口引用:DescribeAllNamespaces

名称 必选 允许NULL 类型 描述
Id String 命名空间标示
示例值: performance_metric
Name String 命名空间名称
示例值: 性能指标
Value String 命名空间值
示例值: qwer
ProductName String 产品名称
示例值: cvm_device
Config String 配置信息
示例值: qwer
AvailableRegions Array of String 支持地域列表
示例值: ["bj","bjjr"]
SortId Int64 排序Id
示例值: 251
DashboardId String Dashboard中的唯一表示
示例值: eipv6

WebStorageInfos

dashboard弹窗信息管理

被如下接口引用:DescribeWebStorage

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

SubscribeInfo

DescribeSubscribeInfo的出参

被如下接口引用:DescribeSubscribeInfo

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

DescribePolicyConditionListConfigManualStatType

DescribePolicyConditionList.ConfigManual.StatType

被如下接口引用:DescribePolicyConditionList

名称 必选 允许NULL 类型 描述
P5 String 数据聚合方式,周期5秒
示例值: 5
P10 String 数据聚合方式,周期10秒
示例值: 10
P60 String 数据聚合方式,周期1分钟
示例值: 60
P300 String 数据聚合方式,周期5分钟
示例值: 300
P600 String 数据聚合方式,周期10分钟
示例值: 600
P1800 String 数据聚合方式,周期30分钟
示例值: 1800
P3600 String 数据聚合方式,周期1小时
示例值: 3600
P86400 String 数据聚合方式,周期1天
示例值: 86400

UnifyDashboardMeta

dashboard列表元素信息

被如下接口引用:DescribeUnifyDashboards

名称 必选 允许NULL 类型 描述
UUID String dashboard uuid
示例值: 1234
IsStarred Bool 是否收藏
示例值: false
Title String dashboard名
示例值: 1735179378
IsDefault Bool 是否默认
示例值: false
Type String dashboard类型
示例值: qwer
LastVisitTime String 最近访问时间
示例值: 1735179378
CreatedAt String 创建时间
示例值: qwer
UpdatedAt String 更新时间
示例值: qwer
FolderUUID String 文件夹uuid
示例值: f-ikxn2fzkagqrdijo
IsFolder Bool 是否文件夹
示例值: false
Order String 顺序
示例值: desc

AlarmPolicyCondition

告警策略指标触发条件

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

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

BindingPolicyObjectDimension

策略绑定实例维度信息

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

名称 必选 允许NULL 类型 描述
RegionId Int64 地域ID
示例值: 1
Region String 地域名
示例值: gz
Dimensions String 维度信息
示例值: {"unInstanceId":"ins-00jvv9mo"}
EventDimensions String 事件维度信息
示例值: {"uuid":"c734cd0d-d050-44bd-8d17-f6381039b4b6"}

CgrpInstanceNode

分组实例详细

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

名称 必选 允许NULL 类型 描述
Id String 自增Id
示例值: 1234
InstanceId String 实例Id
示例值: ins-00jvv9mo
InstanceName String 实例名称
示例值: test
TypeId String 实例类型
示例值: cvm_device
Region String 地域
示例值: gz
ModuleId Int64 叶子分组Id
示例值: 1
ModuleName String 叶子分组名称
示例值: qwer
L1Id Int64 一级分组Id
示例值: 1
L2Id Int64 二级分组Id
示例值: 1
L3Id Int64 三级分组Id
示例值: 1
AppId Int64 appId
示例值: 1234
Uin String Uin
示例值: 123456
SubUin String SubUin
示例值: 123456
Group Array of CgrpInstanceGroupNode 分组数组
示例值:查看

DescribeAccidentConfigAccidentTypeInfo

DescribeAccidentConfig接口的事件类型

被如下接口引用:DescribeAccidentConfig

名称 必选 允许NULL 类型 描述
AccidentId Int64 平台事件id
示例值: 1
AccidentName String 平台事件名称
示例值: qwer
AccidentEnName String 平台事件英文名称
示例值: qwer

DescribePolicyQuotaV3ResponseDataQuota

DescribePolicyQuotaV3ResponseDataQuota

被如下接口引用:DescribePolicyQuota

名称 必选 允许NULL 类型 描述
Used Int64 用户
示例值: 10
Total Int64 总数
示例值: 10

AlarmPolicy

告警策略详情

被如下接口引用:DescribeAlarmPolicies、DescribeAlarmPolicy

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

MetricTooltip

指标的富文本提示语

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

名称 必选 允许NULL 类型 描述
Message String 文本内容
示例值: 这个指标代表该实例的 CPU 使用率
URL String 详情链接
示例值: https://fincloud.tencent.com/
UrlName String 链接名称
示例值: 查看详情

ClmAnalysisFilter

CLM多维分析中的过滤条件

被如下接口引用:DescribeDimensionAnalysisData、DescribeMetricAnalysisData

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

ClmMetricSet

日志监控指标集

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

名称 必选 允许NULL 类型 描述
LogsetId String CLS日志集ID
示例值: d5f10b84-def8-4e58-bab0-16ef567b1f22
LogsetName String CLS日志集名
示例值: 测试
LogtopicId String CLS日志主题ID
示例值: d4253323-7dfc-4b1b-8889-d82cef77375a
LogtopicName String CLS日志主题名
示例值: 测试
Name String 指标集名称
示例值: 测试
StatisticCycle Int64 统计周期 可选:60、300
示例值: 1
TimeField String 时间字段
示例值: 3131431
LogFilterRules Array of ClmLogFilterRule 日志过滤规则
示例值:查看
MetricBasicItems Array of ClmMetricBasicItem 基础指标规则
示例值:查看
MetricCustomItems Array of ClmMetricCustomItem 复合指标规则
示例值:查看
Dimensions Array of ClmDimension 维度规则
示例值:查看
Id Int64 条目ID(只作出参,入参不填)
示例值: 1
CreatedAt String 创建时间(只作出参,入参不填)
示例值: eqeadfrqc
UpdatedAt String 更新时间(只作出参,入参不填)
示例值: eqeadfrqc
AppId Int64 APPID(只作出参,入参不填)
示例值: 1234
Uin String UIN(只作出参,入参不填)
示例值: 123456
Region String 地域(只作出参,入参不填)
示例值: gz
LogProfileItems Array of ClmLogProfileItem 日志数据结构描述
示例值:查看

DescribeBaseMetricsForConsoleFontEndData

DescribeBaseMetricsForConsoleFontEndData

被如下接口引用:DescribeBaseMetricsForConsoleFontEnd

名称 必选 允许NULL 类型 描述
NameSpace String 名字空间
示例值: QCE/CVM
MetricName String 指标名
示例值: CpuUsage
MetricCNName String 指标中文名
示例值: cpu利用率
MetricENName String 指标英文名
示例值: CpuUsage
Dimensions String 维度
示例值: {"unInstanceId":"ins-xxx"}
Unit String 单位
示例值: %
UnitCNName String 单位中午名
示例值: 百分比
PeriodAndStatTypes Array of DescribeBaseMetricsDataPeriod 周期与统计方式
示例值:查看
Meaning Array of DescribeBaseMetricsDataMeaning 指标含义
示例值:查看

IdcInfo

IdcInfo

被如下接口引用:DescribeIdcServerCount

名称 必选 允许NULL 类型 描述
IdcId Int64 地域ID
示例值: 12345
ServerCount Int64 实例数
示例值: 10
IdcName String 地域名称
示例值: 测试

DescribeBaseMetricsDataPeriod

DescribeBaseMetricsDataPeriod

被如下接口引用:DescribeBaseMetricsForConsoleFontEnd

名称 必选 允许NULL 类型 描述
Period Uint64 周期
示例值: 60
StatType Array of String 统计方式
示例值: ["avg"]

DescribePolicySituationAlarmSituation

DescribePolicySituationAlarmSituation

被如下接口引用:DescribePolicySituation

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

PCLMStatisticFilterRule

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

被如下接口引用:CLMDescribeMetricSets

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

CgrpInstance

新建实例Id

被如下接口引用:CreateInstances、DeleteInstances

名称 必选 允许NULL 类型 描述
InstanceId String 实例ID
示例值: ins-00jvv9mo
InstanceName String 实例名称
示例值: test
TypeId String 类型
示例值: cvm_device
Region String 地域
示例值: gz
ModuleId Int64 叶子分组节点
示例值: 1

BigCustomerNotice

大客户通知

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

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

IdcInfoData

IdcInfoData

被如下接口引用:DescribeIdcServerCount

名称 必选 允许NULL 类型 描述
Data Array of IdcInfo 返回数据
示例值:查看
TotalCount Int64 总数
示例值: 10

AttributeInfoOutput

属性信息

被如下接口引用:DescribeAttributes、DescribeCCMGroupViewAttribute

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

DescribePolicyGroupListGroupInstanceGroup

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

被如下接口引用:DescribePolicyGroupList

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

CCMChartData

CCMChartData

被如下接口引用:DescribeCCMCharts

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

ClmLogProfileItem

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

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

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

DashboardMetricEntry

Dashboard2.0指标信息

被如下接口引用:DescribeDashboardMetrics

名称 必选 允许NULL 类型 描述
Namespace String 命名空间值
示例值: QCE/CVM
MetricName String 指标名称
示例值: WanIntraffic
MetricType String 指标类型
示例值: QCEMetric
Aggregations Array of String 指标具有的聚合方式
示例值: Max
Description String 指标展示名称
示例值: 外网入带宽
Unit String 指标数据单位
示例值: Mbps
Min Float 最小值
示例值: 0
Max Float 最大值
示例值: 0
Dimensions Array of String 维度列表
示例值: {"unInstanceId":"ins-xxx"}

DescribeProductEventListEventsDimensions

DescribeProductEventList返回的Events的Dimensions

被如下接口引用:DescribeProductEventList

名称 必选 允许NULL 类型 描述
Key String 维度名(英文)
示例值: readOnly
Name String 维度名(中文)
示例值: 磁盘只读
Value String 维度值
示例值: qwer