数据结构

最近更新时间: 2024-09-03 18:50:00

ClmAnalysisFilter

CLM多维分析中的过滤条件

被如下接口引用:DescribeDimensionAnalysisData、DescribeMetricAnalysisData

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

DescribePolicyInfoByInstanceInstanceGroup

DescribePolicyInfoByInstanceInstanceGroup

被如下接口引用:DescribePolicyInfoByInstance

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

PCLMMetricAnalysisCustomMetric

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

被如下接口引用:

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

DescribePolicyGroupListGroupInstanceGroup

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

被如下接口引用:DescribePolicyGroupList

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

AttributeTimestampValueOutput

AttributeTimestampValueOutput

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

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

ModifyPolicyGroupEventCondition

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

被如下接口引用:ModifyPolicyGroup

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

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天

DescribePolicyQuotaV3ResponseDataQuotaList

DescribePolicyQuotaV3ResponseDataQuotaList

被如下接口引用:DescribePolicyQuota

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

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 修改时间

DescribeEventPolicyConfigDimension

DescribeEventPolicyConfigDimension

被如下接口引用:DescribeEventPolicyConfig

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

DescribeAlarmCallbackHistory

历史回调信息

被如下接口引用:DescribeAlarmCallbackHistory

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

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

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

CustomAlarmInfo

DescribeCustomAlarmList

被如下接口引用:

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

ModifyNotifyBatchNotifyInfo

ModifyNotifyBatch接口的告警通知方式

被如下接口引用:ModifyNotifyBatch

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

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:标签不存在

DescribePolicyInfoByInstanceConditionsTemp

DescribePolicyInfoByInstanceConditionsTemp

被如下接口引用:DescribePolicyInfoByInstance

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

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

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 属性唯一字符串,字母、数字、横杠或下划线组成

DescribeProductEventListEventsGroupInfo

DescribeProductEventList返回的Events里的GroupInfo

被如下接口引用:DescribeProductEventList

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

ClmDescribeAlertPoliciesData

CLM告警策略列表返回结构

被如下接口引用:DescribeAlertPolicies

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

DescribePolicyConditionListConfigManualCalcType

DescribePolicyConditionList.ConfigManual.CalcType

被如下接口引用:DescribePolicyConditionList

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

DescribeProductEventListEventsDimensions

DescribeProductEventList返回的Events的Dimensions

被如下接口引用:DescribeProductEventList

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

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 视图名

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 更新时间(只作出参,入参不填)

DescribeAgentStatusHistory

DescribeAgentStatusHistory

被如下接口引用:DescribeAgentStatusHistory

名称 必选 允许NULL 类型 描述
Timestamp 是 否 Datetime_iso 时间戳
Status 是 否 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 顺序

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

DescribePolicyQuotaV3ResponseDataQuota

DescribePolicyQuotaV3ResponseDataQuota

被如下接口引用:DescribePolicyQuota

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

GroupIdTag

1.0策略ID、标签

被如下接口引用:DescribeGroupIDByTags

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

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 更新时间(只作出参,入参不填)

DescribeBindingPolicyObjectListInstanceGroup

DescribeBindingPolicyObjectList返回的是实例分组信息

被如下接口引用:DescribeBindingPolicyObjectList

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

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 是否为与关系

AttributeIdOutput

AttributeIdOutput

被如下接口引用:ModifyAttribute

名称 必选 允许NULL 类型 描述
AttributeId 是 是 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

CommonNamespace

统一的命名空间信息

被如下接口引用:DescribeAllNamespaces

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

DescribePolicyQuotaV3ResponseData

DescribePolicyQuotaV3ResponseData

被如下接口引用:DescribePolicyQuota

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

DescribePolicyConditionListConfigManual

DescribePolicyConditionList.ConfigManual

被如下接口引用:DescribePolicyConditionList

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

CvmAgentStatus

DescribeCvmAgentStatus接口返回的agent状态

被如下接口引用:DescribeCvmAgentStatus

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

RegionPolicyObjectCount

DescribePolicyObjectCount接口返回的地域统计

被如下接口引用:DescribePolicyObjectCount

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

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 属性唯一名称。由字母、数字、横杠或下划线组成

EventCondition

事件告警条件

被如下接口引用:DescribeConditionsTemplateList、DescribeRecommendedTemplate

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

DescribePolicyGroupInfoConditionTpl

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

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

ViewIdOutput

ViewIdOutput

被如下接口引用:

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

PCLMLogProfileItem

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

被如下接口引用:CLMDescribeMetricSets

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

IdcInfo

IdcInfo

被如下接口引用:DescribeIdcServerCount

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

DescribeSortObjectListDimension

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

被如下接口引用:DescribeSortObjectList

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

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 更新时间(只作出参,入参不填)

DimensionsDesc

维度信息

被如下接口引用:DescribeBaseMetrics

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

MonitorTypeInfo

监控类型详细信息

被如下接口引用:DescribeMonitorTypes

名称 必选 允许NULL 类型 描述
Id 是 否 String 监控类型ID
Name 是 否 String 监控类型
SortId 是 否 Int64 排列顺序

ClmModifyAlertPolicyStatusParam

ClmModifyAlertPolicyStatusParam 更新告警策略状态参数

被如下接口引用:

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

AttributeInfoOutputData

属性数据列表

被如下接口引用:DescribeAttributes

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

DescribePolicyConditionListConfigManualCalcValue

DescribePolicyConditionList.ConfigManual.CalcValue

被如下接口引用:DescribePolicyConditionList

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

MonitorProductInfo

DescribeMonitorProductByIds接口返回的产品信息

被如下接口引用:DescribeMonitorProductByIds

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

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 是否为与关系规则

MetricObjectMeaning

指标数据的解释

被如下接口引用:DescribeBaseMetrics

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

Dimension

实例对象的维度组合

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

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

InstanceGroups

告警对象所属实例组

被如下接口引用:DescribeAlarmHistories、DescribeMiniDashboardAlarmInfo

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

ArgusOverviewNamespaceOut

Argus概览页的Namespace

被如下接口引用:

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

AttributeUnitInfoOutput

AttributeUnitInfoOutput

被如下接口引用:DescribeAttributeUnits

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

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 复合指标表达式 (基础指标传空)

MonitorTypeNamespace

策略类型

被如下接口引用:DescribeAlarmHistories

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

ServerInfoData

ServerInfoData

被如下接口引用:DescribeServers

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

ClmMetricAnalysisCompareData

CLM指标分析对比数据

被如下接口引用:

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

MonitorDimensionSource

维度Key Sources

被如下接口引用:DescribeDashboardDimensionKeys

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

DashboardPanel

dashboard的panel

被如下接口引用:AddDashboardPanels、TopDashboardPanel

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

PCLMMetricCustomItem

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

被如下接口引用:CLMDescribeMetricSets

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

PCLMDescribeMetricSetsData

CLMDescribeMetricSets 返回数据

被如下接口引用:CLMDescribeMetricSets

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

ModifyRecoverNotifyBatchNotifyInfo

ModifyRecoverNotifyBatch恢复方式信息

被如下接口引用:ModifyRecoverNotifyBatch

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

DashboardDimensionSource

Dashboard2.0维度列表

被如下接口引用:DescribeDashboardDimensionKeys

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

WebStorageInfos

dashboard弹窗信息管理

被如下接口引用:DescribeWebStorage

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

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 类型

DescribeGraphDataPartition

DescribeGraphDataPartition

被如下接口引用:DescribeGraphData

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

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 后缀

MetricData

DescribeMetricData接口出参

被如下接口引用:DescribeDataForMiniProgram、DescribeStatisticData

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

PCLMDescribeAlertPoliciesData

PCLMDescribeAlertPoliciesData

被如下接口引用:

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

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)

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列表

ModifyMsgPolicyVoiceConfig

自定义消息语音告警配置

被如下接口引用:CreateMsgPolicy、ModifyMsgPolicy

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

CgrpInstanceGroupNode

实例所在都分组数组

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

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

AttributeServerInfoOutput

AttributeServerInfoOutput

被如下接口引用:DescribeAttributeAllServer、DescribeIdcServer

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

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秒触发一次

AlarmEvent

告警事件

被如下接口引用:DescribeAlarmEvents

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

DescribeBindingPolicyObjectListDimension

DescribeBindingPolicyObjectList接口的Dimension

被如下接口引用:DescribeBindingPolicyObjectList

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

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 更新时间

ClmMetricAnalysisBasicMetric

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

被如下接口引用:DescribeMetricAnalysisData

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

MetricDatum

指标名称和值的封装

被如下接口引用:PutMonitorData

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

CustomAlarmList

CustomAlarmList

被如下接口引用:DescribeCustomAlarmList

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

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 数据源数据是否只读

ServerAttributeDataOutput

ServerAttributeDataOutput

被如下接口引用:DescribeServerDatas

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

MonitorSelectedDimension

已选择维度

被如下接口引用:DescribeDashboardDimensionValues

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

PCLMMetricAnalysisData

Clm指标分析data结构

被如下接口引用:DescribeMetricAnalysisData

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

SubscribeInfoReceiver

DescribeSubscribeInfo出参

被如下接口引用:DescribeSubscribeInfo

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

ConditionsTemp

告警条件模版

被如下接口引用:DescribeAlarmPolicies、DescribeAlarmPolicy

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

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 排序个数

MoveFailReason

移动dashboard失败原因

被如下接口引用:MoveUnifyDashboards

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

CCMGroupViewEntry

CCMGroupViewEntry

被如下接口引用:DescribeCCMGroupView

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

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 过滤操作值

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 维度描述信息

ClmDescribeMetricSetsData

DescribeMetricSets 返回数据

被如下接口引用:DescribeMetricSets

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

ClmMetricAnalysisCurrentData

CLM指标分析当前数据

被如下接口引用:

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

DescribeBaseMetricsDataPeriod

DescribeBaseMetricsDataPeriod

被如下接口引用:DescribeBaseMetricsForConsoleFontEnd

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

InstanceGroupInfo

DescribeInstanceGroup接口返回的 InstanceGroupInfo 接口

被如下接口引用:DescribeInstanceGroup

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

MidQueryCondition

DescribeMidDimensionValueList的查询条件

被如下接口引用:DescribeMidDimensionValueList、DescribeStatisticData

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

ServiceInfo

ServiceInfo

被如下接口引用:CreateService、DescribeService

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

StrategyStatesInfo

StrategyStatesInfo

被如下接口引用:ModifyStrategyStates

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

AlarmPolicyEventCondition

告警策略事件触发条件

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

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

ArgusAggType

Argus聚合方式

被如下接口引用:

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

AlarmHistory

告警历史数据

被如下接口引用:DescribeAlarmHistories、DescribeMiniDashboardAlarmInfo

名称 必选 允许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

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 过滤操作值

AlarmBindingInstance

AlarmBindingInstance

被如下接口引用:DescribeAlarmBindingInstanceList

名称 必选 允许NULL 类型 描述
UUID 是 否 String 实例UUID
Information 是 否 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 更新的时间戳

PolicyTag

策略标签

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

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

StrategyIdInfo

StrategyIdInfo

被如下接口引用:CreateStrategy

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

ArgusDimensionOut

Argus维度字段

被如下接口引用:

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

CustomMetisAbnormOutput

智能异常检测结果数组

被如下接口引用:

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

TemplateTag

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

被如下接口引用:DescribeTemplateTags

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

ProductListForDescribeMonitorProducts

DescribeMonitorProducts 出参 ProductList 数组

被如下接口引用:

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

AttributeServerInfoOutputData

AttributeServerInfoOutputData

被如下接口引用:DescribeAttributeAllServer、DescribeIdcServer

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

DescribeMsgPolicyListVoiceConfig

DescribeMsgPolicyListVoiceConfig

被如下接口引用:DescribeMsgPolicyInfo、DescribeMsgPolicyList

名称 必选 允许NULL 类型 描述
RoundNumber 是 否 Int64 呼叫次数
UIDList 是 是 Array of Int64 UIN列表
RoundInterval 是 否 Int64 每轮间隔
PersonInterval 是 否 Int64 没人间隔
NeedSendNotice 是 否 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 告警次数

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

PeriodsSt

周期内的统计方式

被如下接口引用:DescribeBaseMetrics

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

CustomMetisAbnormlInput

自定义监控智能检测

被如下接口引用:

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

StrategyChannelInfo

StrategyChannelInfo

被如下接口引用:ModifyStrategyChannels

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

DescribePolicyGroupInfoEventCondition

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

被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList

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

DescribePolicyConditionListEventMetric

DescribePolicyConditionList.EventMetric

被如下接口引用:DescribePolicyConditionList

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

DescribeDashboardViewList

DescribeDashboardViewList

被如下接口引用:DescribeDashboardViews

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

CCMDashboardData

自定义监控 CCMDashboardData

被如下接口引用:

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

DescribeProductEventListDimensions

DescribeProductEventList的入参Dimensions

被如下接口引用:DescribeProductEventList

名称 必选 允许NULL 类型 描述
Name 是 否 String 维度名
Value 是 否 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 维度列表

DescribePolicyConditionListMetric

指标告警配置

被如下接口引用:DescribePolicyConditionList

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

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 指标英文描述,唯一名称

PCLMAlertFilterRule

CLM告警过滤条件

被如下接口引用:

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

AttributeValueInfoOutputData

AttributeValueInfoOutputData

被如下接口引用:DescribeServerData、DescribeViewData

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

ClmDimension

日志监控指标集维度对象

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

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

DescribeBindingPolicyObjectListInstance

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

被如下接口引用:DescribeBindingPolicyObjectList

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

Dimensions

实例对象的维度组合

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name 是 否 String 实例维度名称
Value 是 否 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

MiniDashboardAlarmInfo

MiniDashboard AlarmInfo

被如下接口引用:DescribeMiniDashboardAlarmInfo

名称 必选 允许NULL 类型 描述
Dimension 否 否 String 维度信息
NoPolicy 否 否 Bool 无告警策略
DefaultPolicyWithoutNotice 否 否 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

PCLMAnalysisFilter

CLM多维分析中的过滤条件

被如下接口引用:

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

DescribeAlarmSmsQuotaQuota

DescribeAlarmSmsQuota接口的配额信息

被如下接口引用:DescribeAlarmSmsQuota

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

DescribePolicyConditionListConfigManualPeriod

DescribePolicyConditionList.ConfigManual.Period

被如下接口引用:DescribePolicyConditionList

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

DescribeAgentStatusHistoryData

DescribeAgentStatusHistoryData

被如下接口引用:DescribeAgentStatusHistory

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

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 持续多长时间触发规则会告警(单位秒)

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列表。

DescribeDashboardsList

DescribeDashboardsList

被如下接口引用:DescribeDashboards

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

DescribeEventPolicyConfig

DescribeEventPolicyConfig

被如下接口引用:DescribeEventPolicyConfig

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

AlarmPolicyFilter

告警策略过滤条件

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

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

DescribePolicyGroupInfoCallback

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

被如下接口引用:DescribePolicyGroupInfo

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

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字符串

ClmLogProfileItem

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

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

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

PCLMMetricAnalysisPoint

CLM指标分析数据点

被如下接口引用:DescribeMetricAnalysisData

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

DataPoint

监控数据点

被如下接口引用:GetMonitorData

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

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 过期信息

AlarmPolicyQuota

告警2.0策略具体配额

被如下接口引用:DescribeAlarmObjectQuota、DescribeAlarmPolicyQuota

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

DescribeAccidentConfigAccidentTypeInfo

DescribeAccidentConfig接口的事件类型

被如下接口引用:DescribeAccidentConfig

名称 必选 允许NULL 类型 描述
AccidentId 是 否 Int64 平台事件id
AccidentName 是 否 String 平台事件名称
AccidentEnName 是 否 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(只作出参,入参不填)

AlarmPolicyTriggerTask

告警策略触发任务

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

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

DescribeAccidentConfigAccident

DescribeAccidentConfig接口的平台事件

被如下接口引用:DescribeAccidentConfig

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

DescribeInstanceGroupListPolicyGroup

DescribeInstanceGroupList接口返回的策略组信息

被如下接口引用:DescribeInstanceGroupList

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

CgrpInstance

新建实例Id

被如下接口引用:CreateInstances、DeleteInstances

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 实例ID
InstanceName 否 否 String 实例名称
TypeId 否 否 String 类型
Region 否 否 String 地域
ModuleId 是 否 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 指标单位

ServerAttributeInfo

ServerAttributeInfo

被如下接口引用:

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

CustomMetisAbnormOutputView

自定义监控智能检测View

被如下接口引用:

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

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

MetricTooltip

指标的富文本提示语

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

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

CCMChartData

CCMChartData

被如下接口引用:DescribeCCMCharts

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

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 所属实例组信息

TransLogInstance

DescribeTransLog返回的实例List

被如下接口引用:DescribeInstanceGroup

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

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表示且规则(所有规则都满足阈值条件才告警)

ClmMetricAnalysisCustomMetric

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

被如下接口引用:DescribeMetricAnalysisData

名称 必选 允许NULL 类型 描述
Name 否 否 String 复合指标名
Formula 是 否 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

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 更新时间(只作出参,入参不填)

ProductSimple

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

被如下接口引用:DescribeProductList

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

NameTypeBak

NameType

被如下接口引用:

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

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

DescribeMonitorProductsProductMetaAlarm

DescribeMonitorProducts.productList.meta.alarm

被如下接口引用:

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

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

DescribePolicyConditionListConfigManualPeriodNum

DescribePolicyConditionList.ConfigManual.PeriodNum

被如下接口引用:DescribePolicyConditionList

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

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 创建时间

InstanceGroup

DescribeBasicAlarmList返回的Alarms里的InstanceGroup

被如下接口引用:DescribeBasicAlarmList

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

DashboardMetricCondition

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

被如下接口引用:DescribeDashboardMetricData

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

PCLMMetricAnalysisBasicMetric

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

被如下接口引用:

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

AttributeUnitInfoOutputData

AttributeUnitInfoOutputData

被如下接口引用:DescribeAttributeUnits

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

PolicyGroupItem

DescribeInstanceGroup 返回的 PolicyGroups

被如下接口引用:DescribeInstanceGroup

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

URLNotice

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

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

名称 必选 允许NULL 类型 描述
URL 是 是 String 回调 url(限长256字符)
IsValid 否 是 Int64 是否通过验证 0=否 1=是
ValidationCode 否 是 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

IdcData

IdcData

被如下接口引用:DescribeIdcTree

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

MetricConfig

指标配置

被如下接口引用:DescribeAlarmMetrics

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

ArgusDimensionIn

Argus维度字段

被如下接口引用:

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

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

ModifyConditionsTemplateRequestEventCondition

ModifyConditionsTemplateRequestEventCondition

被如下接口引用:CreateConditionsTemplate、ModifyConditionsTemplate

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

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 创建时间

CreatePolicyGroupEventCondition

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

被如下接口引用:CreatePolicyGroup

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

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 策略信息

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

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=是

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 指标含义

AttributeAggrValueInfoOutputData

AttributeAggrValueInfoOutputData

被如下接口引用:DescribeAttributeAggregateData

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

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 复合指标表达式 (基础指标传空)

DescribeStorageDurationData

DescribeStorageDurationData

被如下接口引用:DescribeStorageDuration

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

ModifyConditionsTemplateRequestCondition

ModifyConditionsTemplateRequestCondition

被如下接口引用:CreateConditionsTemplate、ModifyConditionsTemplate

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

AlarmPolicyBasic

告警2.0告警策略基本信息

被如下接口引用:DescribeAlarmPoliciesBasic

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

DescribeAppFlowConverterResponseDataPoint

DescribeAppFlowConverterResponseDataPoint

被如下接口引用:DescribeAppFlow

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

ServerInfo

ServerInfo

被如下接口引用:DescribeServers

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

AttributeValueInfoOutput

AttributeValueInfoOutput

被如下接口引用:DescribeServerData、DescribeViewData

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

DescribePolicyConditionListConfigManualContinueTime

DescribePolicyConditionList.ConfigManual.ContinueTime

被如下接口引用:DescribePolicyConditionList

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

ProductHealthStatus

DescribeProductHealthStatusList接口返回的HealthStatus

被如下接口引用:DescribeProductHealthStatusList

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

DescribeProductEventListOverView

DescribeProductEventList返回的OverView对象

被如下接口引用:DescribeProductEventList

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

TransLogItem

DescribeTransLog返回的一条变更日志

被如下接口引用:DescribeTransLog

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

ClmAlertFilterRule

已失效

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

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

PCLMDimensionAnalysisResultData

维度分析结果数据

被如下接口引用:DescribeDimensionAnalysisData

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

ArgusMetricIn

Argus指标字段

被如下接口引用:

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

DescribePolicySituationAlarmSituation

DescribePolicySituationAlarmSituation

被如下接口引用:DescribePolicySituation

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

MetricAggregation

指标的聚合方式

被如下接口引用:DescribeAlarmMetrics

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

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或

Point

监控数据点

被如下接口引用:

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

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"

DescribePolicyUseList

DescribePolicyUseList返回的对象

被如下接口引用:DescribePolicyUseList

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

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 分组数组

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 日志数据结构描述

DescribeBaseMetricsDataMeaning

DescribeBaseMetricsDataMeaning

被如下接口引用:DescribeBaseMetricsForConsoleFontEnd

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

PCLMDimension

日志监控指标集维度对象

被如下接口引用:CLMDescribeMetricSets

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

CustomMetisAbnormOutputAttr

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

被如下接口引用:

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

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

AlarmHistoryMetric

告警历史的指标信息

被如下接口引用:DescribeAlarmHistories、DescribeMiniDashboardAlarmInfo

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

DescribeMonitorDataByAlarmIDDataPoint

DescribeMonitorDataByAlarmIDDataPoint

被如下接口引用:DescribeMonitorDataByAlarmID

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

Instance

实例维度组合数组

被如下接口引用:DescribePolicyGroupCount、GetMonitorData

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

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列表

AttributeIdDeleteOutput

AttributeIdDeleteOutput

被如下接口引用:DeleteAttribute、DeleteAttributes

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

CCMInstanceAttributeDataOutput

CCMInstanceAttributeDataOutput

被如下接口引用:DescribeCCMInstanceDatas

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

ClmMetricCustomItem

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

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

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

IdcInfoData

IdcInfoData

被如下接口引用:DescribeIdcServerCount

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

ArgusMapOut

Argus通用Map

被如下接口引用:

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

BindingPolicyObjectDimension

策略绑定实例维度信息

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

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

StrategyData

StrategyData

被如下接口引用:DescribeCCMGroupViewStrategy、DescribeStrategys

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

AlarmPolicyCondition

告警策略指标触发条件

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

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

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 绑定的告警策略组列表