PCLMDimensionAnalysisResultData
维度分析结果数据
被如下接口引用:DescribeDimensionAnalysisData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Current | 是 | 否 | String | 维度数据 示例值: |
Granularity | 是 | 否 | Int64 | 粒度 示例值: |
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 | 指标单位名称 示例值: |
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 示例值: |
DescribeMonitorDataByAlarmIDDataPoint
DescribeMonitorDataByAlarmIDDataPoint
被如下接口引用:DescribeMonitorDataByAlarmID
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
IsNull | 是 | 否 | Bool | 是否为空 示例值: |
Value | 是 | 否 | Float | 数据值 示例值: |
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 | 创建时间 示例值: |
CustomMetisAbnormOutputAttr
自定义监控智能检测检测结果Attr
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AttrId | 是 | 是 | Uint64 | 自定义监控属性ID 示例值: |
Abnormals | 是 | 是 | Array of Uint64 | 异常点 示例值: |
ProductHealthStatus
DescribeProductHealthStatusList接口返回的HealthStatus
被如下接口引用:DescribeProductHealthStatusList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ViewName | 是 | 是 | String | 视图名 示例值: |
HealthStatus | 是 | 是 | Int64 | 健康状态,1表示未恢复 示例值: |
WarningCount | 是 | 是 | Int64 | 提醒的数量 示例值: |
AbnormalCount | 是 | 是 | Int64 | 异常的数量 示例值: |
AlarmRegions | 是 | 是 | Array of String | 告警的地域列表 示例值: |
DescribeAgentStatusHistoryData
DescribeAgentStatusHistoryData
被如下接口引用:DescribeAgentStatusHistory
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
UnInstanceID | 是 | 否 | String | 实例ID 示例值: |
Status | 是 | 否 | Int64 | 子机状态 示例值: |
Histories | 是 | 否 | Array of DescribeAgentStatusHistory | 历史数据 示例值:查看 |
CustomMetisAbnormOutputView
自定义监控智能检测View
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ViewId | 是 | 是 | Uint64 | 自定义监控视图ID 示例值: |
AttrAbnormals | 是 | 是 | Array of CustomMetisAbnormOutputAttr | 自定义监控智能检测结果View 示例值:查看 |
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 示例值: |
ClmDescribeAlertPoliciesData
CLM告警策略列表返回结构
被如下接口引用:DescribeAlertPolicies
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
TotalCount | 是 | 是 | Int64 | 总数 示例值: |
AlertPolicies | 是 | 是 | Array of ClmAlertPolicy | 列表元素 示例值:查看 |
MonitorTypeNamespace
策略类型
被如下接口引用:DescribeAlarmHistories
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MonitorType | 是 | 否 | String | 监控类型 示例值: |
Namespace | 是 | 否 | 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 | 更新时间(只作出参,入参不填) 示例值: |
AlarmPolicyEventCondition
告警策略事件触发条件
被如下接口引用:CreateAlarmPolicy、DescribeAlarmPolicies、DescribeAlarmPolicy、ModifyAlarmPolicyCondition
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Rules | 是 | 是 | Array of AlarmPolicyRule | 告警触发条件列表 示例值:查看 |
CgrpInstance
新建实例Id
被如下接口引用:CreateInstances、DeleteInstances
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceId | 是 | 否 | String | 实例ID 示例值: |
InstanceName | 否 | 否 | String | 实例名称 示例值: |
TypeId | 否 | 否 | String | 类型 示例值: |
Region | 否 | 否 | String | 地域 示例值: |
ModuleId | 是 | 否 | Int64 | 叶子分组节点 示例值: |
SubscribeInfo
DescribeSubscribeInfo的出参
被如下接口引用:DescribeSubscribeInfo
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
BusinessId | 是 | 是 | Int64 | 事件类型Id 示例值: |
BusinessName | 是 | 是 | String | 事件名 示例值: |
AccidentId | 是 | 是 | Int64 | 问题类型Id 示例值: |
AccidentName | 是 | 是 | String | 问题名 示例值: |
NotifyWay | 是 | 是 | Array of Int64 | 通知方式 示例值: |
Receivers | 是 | 是 | Array of SubscribeInfoReceiver | 接收人列表 示例值:查看 |
Tips | 是 | 是 | String | 提示 示例值: |
UserConfig | 是 | 是 | String | 用户配置,json字符串 示例值: |
AttributeValueInfoOutputData
AttributeValueInfoOutputData
被如下接口引用:DescribeServerData、DescribeViewData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Data | 是 | 否 | Array of AttributeValueInfoOutput | 属性上报数据列表 示例值:查看 |
TotalCount | 是 | 否 | Int64 | 属性数据列表个数个数 示例值: |
CustomMetisAbnormOutput
智能异常检测结果数组
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ViewAttrAbnormals | 是 | 是 | Array of CustomMetisAbnormOutputView | 视图结果 示例值:查看 |
DescribePolicyConditionListEventMetric
DescribePolicyConditionList.EventMetric
被如下接口引用:DescribePolicyConditionList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
EventId | 是 | 否 | Int64 | 事件id 示例值: |
EventShowName | 是 | 否 | String | 事件名称 示例值: |
NeedRecovered | 是 | 否 | Bool | 是否需要恢复 示例值: |
Type | 是 | 否 | Int64 | 事件类型,预留字段,当前固定取值为2 示例值: |
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 | 顺序 示例值: |
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 | 是否为与关系 示例值: |
ClmMetricAnalysisCustomMetric
CLM指标分析中的复合指标参数
被如下接口引用:DescribeMetricAnalysisData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 否 | 否 | String | 复合指标名 示例值: |
Formula | 是 | 否 | String | 运算表达式 示例值: |
PolicyGroupItem
DescribeInstanceGroup 返回的 PolicyGroups
被如下接口引用:DescribeInstanceGroup
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupId | 是 | 是 | Int64 | 策略Id 示例值: |
GroupName | 是 | 是 | String | 策略名 示例值: |
StrategyIdInfo
StrategyIdInfo
被如下接口引用:CreateStrategy
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
StrategyId | 是 | 否 | Int64 | 告警策略ID 示例值: |
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 | 过期信息 示例值: |
StrategyData
StrategyData
被如下接口引用:DescribeCCMGroupViewStrategy、DescribeStrategys
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Data | 是 | 否 | Array of StrategyEntry | 返回数据 示例值:查看 |
TotalCount | 是 | 否 | Int64 | 查询数据列表总数 示例值: |
MetricDatum
指标名称和值的封装
被如下接口引用:PutMonitorData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MetricName | 是 | 否 | String | 指标名称 示例值: |
Value | 是 | 否 | Uint64 | 指标的值 示例值: |
TransLogItem
DescribeTransLog返回的一条变更日志
被如下接口引用:DescribeTransLog
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Id | 是 | 是 | Int64 | 变更日志Id 示例值: |
ModuleId | 是 | 是 | Int64 | 模块Id 示例值: |
LogData | 是 | 是 | String | 日志信息,json字符串 示例值: |
CreateTime | 是 | 是 | Int64 | 创建时间 示例值: |
LastEditUin | 是 | 是 | String | 最后修改UIN 示例值: |
ClmMetricAnalysisCompareData
CLM指标分析对比数据
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Compare | 是 | 是 | Array of PCLMMetricAnalysisPoint | 对比数据 示例值:查看 |
DescribePolicyInfoByInstanceInstanceGroup
DescribePolicyInfoByInstanceInstanceGroup
被如下接口引用:DescribePolicyInfoByInstance
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceGroupID | 是 | 是 | Int64 | 实例组ID 示例值: |
ViewName | 是 | 否 | String | 视图 示例值: |
LastEditUin | 是 | 是 | Int64 | 最后编辑者UIN 示例值: |
GroupName | 是 | 否 | String | 实例组名称 示例值: |
InstanceSum | 是 | 是 | Int64 | 实例数 示例值: |
UpdateTime | 是 | 是 | Int64 | 更新时间 示例值: |
InsertTime | 是 | 是 | Int64 | 创建时间 示例值: |
DashboardDimensionSource
Dashboard2.0维度列表
被如下接口引用:DescribeDashboardDimensionKeys
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
DataSource | 是 | 否 | String | 数据源 示例值: |
Namespace | 是 | 否 | String | 命名空间 示例值: |
DimensionName | 是 | 否 | String | 维度名 示例值: |
MetricName | 是 | 否 | String | 指标名称 示例值: |
CgrpInstanceGroupNode
实例所在都分组数组
被如下接口引用:CreateInstances、DeleteInstances、DescribeInstance
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Id | 否 | 是 | Int64 | 分组Id 示例值: |
Name | 否 | 是 | String | 分组名称 示例值: |
PeriodsSt
周期内的统计方式
被如下接口引用:DescribeBaseMetrics
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Period | 是 | 否 | String | 周期 示例值: |
StatType | 是 | 否 | Array of 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 | 视图名 示例值: |
MetricData
DescribeMetricData接口出参
被如下接口引用:DescribeDataForMiniProgram、DescribeStatisticData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MetricName | 是 | 否 | String | 无 示例值: |
Points | 是 | 否 | String | 无 示例值: |
DescribeAccidentConfigAccidentTypeInfo
DescribeAccidentConfig接口的事件类型
被如下接口引用:DescribeAccidentConfig
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AccidentId | 是 | 否 | Int64 | 平台事件id 示例值: |
AccidentName | 是 | 否 | String | 平台事件名称 示例值: |
AccidentEnName | 是 | 否 | String | 平台事件英文名称 示例值: |
Instance
实例维度组合数组
被如下接口引用:DescribePolicyGroupCount、GetMonitorData
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 | 所属实例组信息 示例值:查看 |
ServerAttributeInfo
ServerAttributeInfo
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AttributeId | 是 | 否 | Int64 | 指标ID 示例值: |
AttributeName | 是 | 否 | String | 指标名称 示例值: |
AttributeUniqueName | 是 | 否 | String | 指标唯一英文名称 示例值: |
PCLMDescribeMetricSetsData
CLMDescribeMetricSets 返回数据
被如下接口引用:CLMDescribeMetricSets
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MetricSets | 是 | 是 | Array of PCLMMetricSet | 指标集列表数据 示例值:查看 |
TotalCount | 是 | 是 | Int64 | 总数 示例值: |
DescribeMsgPolicyListVoiceConfig
DescribeMsgPolicyListVoiceConfig
被如下接口引用:DescribeMsgPolicyInfo、DescribeMsgPolicyList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
RoundNumber | 是 | 否 | Int64 | 呼叫次数 示例值: |
UIDList | 是 | 是 | Array of Int64 | UIN列表 示例值: |
RoundInterval | 是 | 否 | Int64 | 每轮间隔 示例值: |
PersonInterval | 是 | 否 | Int64 | 没人间隔 示例值: |
NeedSendNotice | 是 | 否 | Int64 | 是否需要发送提醒 示例值: |
DescribeProductEventListOverView
DescribeProductEventList返回的OverView对象
被如下接口引用:DescribeProductEventList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
StatusChangeAmount | 是 | 是 | Int64 | 状态变更的事件数量 示例值: |
UnConfigAlarmAmount | 是 | 是 | Int64 | 告警状态未配置的事件数量 示例值: |
UnNormalEventAmount | 是 | 是 | Int64 | 异常事件数量 示例值: |
UnRecoverAmount | 是 | 是 | Int64 | 未恢复的事件数量 示例值: |
InstanceGroupInfo
DescribeInstanceGroup接口返回的 InstanceGroupInfo 接口
被如下接口引用:DescribeInstanceGroup
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupName | 是 | 是 | String | 实例组名 示例值: |
InstanceGroupId | 是 | 是 | Int64 | 实例组ID 示例值: |
InstanceSum | 是 | 是 | Int64 | 实例数量 示例值: |
ViewName | 是 | 是 | String | 视图名/策略类型 示例值: |
InsertTime | 是 | 是 | Int64 | 创建时间 示例值: |
UpdateTime | 是 | 是 | Int64 | 更新时间 示例值: |
LastEditUin | 是 | 是 | String | 最后更新UIN 示例值: |
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(只作出参,入参不填) 示例值: |
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=是 示例值: |
ClmAnalysisFilter
CLM多维分析中的过滤条件
被如下接口引用:DescribeDimensionAnalysisData、DescribeMetricAnalysisData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Field | 是 | 否 | String | 字段名 示例值: |
Operator | 是 | 否 | String | 运算符 目前只支持 = (当value数组为多个值时为in关系) 示例值: |
Value | 是 | 否 | Array of String | 值 示例值: |
AttributeTimestampValueOutput
AttributeTimestampValueOutput
被如下接口引用:DescribeAttributeAggregateData、DescribeCCMInstanceDatas、DescribeServerData、DescribeServerDatas、DescribeViewData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Timestamp | 是 | 否 | Int64 | 时间戳 示例值: |
Value | 是 | 是 | Int64 | 属性值 示例值: |
MonitorDimensionSource
维度Key Sources
被如下接口引用:DescribeDashboardDimensionKeys
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Namespace | 是 | 否 | String | 命名空间 示例值: |
Metric | 是 | 否 | String | 指标 示例值: |
SearchValue | 是 | 否 | String | 搜索值 示例值: |
CvmAgentStatus
DescribeCvmAgentStatus接口返回的agent状态
被如下接口引用:DescribeCvmAgentStatus
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceId | 是 | 否 | String | 实例ID 示例值: |
AgentInstalled | 是 | 否 | Bool | Agent是否安装 示例值: |
DescribeAppFlowConverterResponseDataPoint
DescribeAppFlowConverterResponseDataPoint
被如下接口引用:DescribeAppFlow
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Value | 是 | 是 | Float | 数据值 示例值: |
AttributeValueInfoOutput
AttributeValueInfoOutput
被如下接口引用:DescribeServerData、DescribeViewData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Values | 是 | 否 | Array of AttributeTimestampValueOutput | 属性值列表 示例值:查看 |
StartTime | 是 | 否 | String | 开始时间 示例值: |
EndTime | 是 | 否 | String | 结束时间 示例值: |
StartPosition | 是 | 否 | Int64 | 开始位置 示例值: |
EndPosition | 是 | 否 | Int64 | 结束位置 示例值: |
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 | 分组数组 示例值:查看 |
EventCondition
事件告警条件
被如下接口引用:DescribeConditionsTemplateList、DescribeRecommendedTemplate
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AlarmNotifyPeriod | 是 | 否 | String | 告警通知频率 示例值: |
AlarmNotifyType | 是 | 否 | String | 重复通知策略预定义(0 - 只告警一次, 1 - 指数告警,2 - 连接告警) 示例值: |
EventID | 是 | 否 | String | 事件ID 示例值: |
EventDisplayName | 是 | 否 | String | 事件展示名称(对外) 示例值: |
RuleID | 是 | 否 | String | 规则ID 示例值: |
ServerInfo
ServerInfo
被如下接口引用:DescribeServers
名称 | 必选 | 允许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秒触发一次 示例值: |
AlarmPolicyBasic
告警2.0告警策略基本信息
被如下接口引用:DescribeAlarmPoliciesBasic
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MonitorType | 是 | 是 | String | 监控类型 示例值: |
OriginId | 是 | 是 | String | 告警策略1.0 Id 示例值: |
PolicyId | 否 | 是 | String | 告警策略2.0 Id 示例值: |
PolicyName | 否 | 是 | String | 告警策略名称 示例值: |
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) 示例值: |
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 | 属性唯一名称。由字母、数字、横杠或下划线组成 示例值: |
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 | 绑定的告警策略组列表 示例值:查看 |
DescribePolicyConditionListConfigManualCalcType
DescribePolicyConditionList.ConfigManual.CalcType
被如下接口引用:DescribePolicyConditionList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Keys | 是 | 是 | Array of Int64 | CalcType 取值 示例值: |
Need | 是 | 否 | Bool | 是否必须 示例值: |
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 | 策略信息 示例值:查看 |
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 | 更新时间(只作出参,入参不填) 示例值: |
CCMGroupViewEntry
CCMGroupViewEntry
被如下接口引用:DescribeCCMGroupView
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ViewId | 是 | 是 | Int64 | 分组视图ID 示例值: |
ViewName | 是 | 是 | String | 分组视图名称 示例值: |
IsAuto | 是 | 是 | Int64 | 分组视图是否自动绑定指标。0:否,1:是 示例值: |
ConditionsTemp
告警条件模版
被如下接口引用:DescribeAlarmPolicies、DescribeAlarmPolicy
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ConditionId | 是 | 是 | Int64 | 告警条件id 示例值: |
TemplateName | 是 | 是 | String | 模版名称 示例值: |
Condition | 是 | 是 | AlarmPolicyCondition | 指标触发条件 示例值:查看 |
EventCondition | 是 | 是 | AlarmPolicyEventCondition | 事件触发条件 示例值:查看 |
DescribeBaseMetricsDataPeriod
DescribeBaseMetricsDataPeriod
被如下接口引用:DescribeBaseMetricsForConsoleFontEnd
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Period | 是 | 否 | Uint64 | 周期 示例值: |
StatType | 是 | 是 | Array of String | 统计方式 示例值: |
ArgusMetricIn
Argus指标字段
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
EnName | 是 | 否 | String | 英文名 示例值: |
CnName | 是 | 否 | String | 中文名 示例值: |
AggType | 是 | 否 | String | 聚合方式 示例值: |
Unit | 是 | 否 | String | 单位 示例值: |
Category | 否 | 否 | String | 分类 示例值: |
CustomAlarmInfo
DescribeCustomAlarmList
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Caller | 是 | 是 | String | 调用方 示例值: |
LocalIP | 是 | 是 | String | IP 示例值: |
Msg | 是 | 是 | String | 消息内容 示例值: |
OccurTime | 是 | 是 | String | 发生时间 示例值: |
DescribePolicyConditionListConfigManualPeriod
DescribePolicyConditionList.ConfigManual.Period
被如下接口引用:DescribePolicyConditionList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Default | 是 | 是 | Int64 | 默认周期,单位:秒 示例值: |
Keys | 是 | 是 | Array of Int64 | 可选周期,单位:秒 示例值: |
Need | 是 | 否 | Bool | 是否必须 示例值: |
DescribeBindingPolicyObjectListInstanceGroup
DescribeBindingPolicyObjectList返回的是实例分组信息
被如下接口引用:DescribeBindingPolicyObjectList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceGroupId | 是 | 否 | Int64 | 实例分组id 示例值: |
ViewName | 是 | 否 | String | 告警策略类型名称 示例值: |
LastEditUin | 是 | 否 | String | 最后编辑uin 示例值: |
GroupName | 是 | 否 | String | 实例分组名称 示例值: |
InstanceSum | 是 | 否 | Int64 | 实例数量 示例值: |
UpdateTime | 是 | 否 | Int64 | 更新时间 示例值: |
InsertTime | 是 | 否 | Int64 | 创建时间 示例值: |
Regions | 是 | 是 | Array of String | 实例所在的地域集合 示例值: |
CreatePolicyGroupEventCondition
创建策略传入的事件告警条件
被如下接口引用:CreatePolicyGroup
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
RuleId | 否 | 否 | Int64 | 如果通过模版创建,需要传入模版中该指标的对应RuleId 示例值: |
EventId | 是 | 否 | Int64 | 告警事件的Id 示例值: |
AlarmNotifyType | 是 | 否 | Int64 | 告警发送收敛类型。0连续告警,1指数告警 示例值: |
AlarmNotifyPeriod | 是 | 否 | Int64 | 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次 示例值: |
InstanceGroups
告警对象所属实例组
被如下接口引用:DescribeAlarmHistories、DescribeMiniDashboardAlarmInfo
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Id | 是 | 否 | Int64 | 实例组 Id 示例值: |
Name | 是 | 否 | String | 实例组名称 示例值: |
ClmModifyAlertPolicyStatusParam
ClmModifyAlertPolicyStatusParam 更新告警策略状态参数
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Id | 是 | 否 | Int64 | 告警策略ID 示例值: |
Status | 是 | 否 | Int64 | 状态:1开启 2关闭 示例值: |
DescribeProductEventListDimensions
DescribeProductEventList的入参Dimensions
被如下接口引用:DescribeProductEventList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | String | 维度名 示例值: |
Value | 是 | 否 | String | 维度值 示例值: |
DescribePolicyConditionListConfigManualStatType
DescribePolicyConditionList.ConfigManual.StatType
被如下接口引用:DescribePolicyConditionList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
P5 | 是 | 是 | String | 数据聚合方式,周期5秒 示例值: |
P10 | 是 | 是 | String | 数据聚合方式,周期10秒 示例值: |
P60 | 是 | 是 | String | 数据聚合方式,周期1分钟 示例值: |
P300 | 是 | 是 | String | 数据聚合方式,周期5分钟 示例值: |
P600 | 是 | 是 | String | 数据聚合方式,周期10分钟 示例值: |
P1800 | 是 | 是 | String | 数据聚合方式,周期30分钟 示例值: |
P3600 | 是 | 是 | String | 数据聚合方式,周期1小时 示例值: |
P86400 | 是 | 是 | String | 数据聚合方式,周期1天 示例值: |
DescribeInstanceGroupListPolicyGroup
DescribeInstanceGroupList接口返回的策略组信息
被如下接口引用:DescribeInstanceGroupList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupId | 是 | 否 | Int64 | 策略组id 示例值: |
GroupName | 是 | 否 | String | 策略组名称 示例值: |
DescribePolicyGroupListGroupInstanceGroup
DescribePolicyGroupList接口策略组绑定的实例分组信息
被如下接口引用:DescribePolicyGroupList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceGroupId | 是 | 否 | Int64 | 实例分组名称id 示例值: |
ViewName | 是 | 否 | String | 策略类型视图名称 示例值: |
LastEditUin | 是 | 否 | String | 最近编辑的用户uin 示例值: |
GroupName | 是 | 否 | String | 实例分组名称 示例值: |
InstanceSum | 是 | 否 | Int64 | 实例数量 示例值: |
UpdateTime | 是 | 否 | Int64 | 更新时间 示例值: |
InsertTime | 是 | 否 | Int64 | 创建时间 示例值: |
DescribePolicyInfoByInstanceGroupList
DescribePolicyInfoByInstanceGroupList
被如下接口引用:DescribePolicyInfoByInstance
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupID | 是 | 否 | Int64 | 策略组ID 示例值: |
GroupName | 是 | 否 | String | 策略名 示例值: |
IsOpen | 是 | 否 | Bool | 是否开启 示例值: |
ViewName | 是 | 否 | String | 视图名 示例值: |
LastEditUin | 是 | 否 | Int64 | 最后编辑者UIN 示例值: |
IsDefault | 是 | 否 | Int64 | 是否为默认策略 示例值: |
CanSetDefault | 是 | 否 | Bool | 是否能设为默认策略 示例值: |
ParentGroupID | 是 | 否 | Int64 | 父策略组ID 示例值: |
Remark | 是 | 否 | String | 备注 示例值: |
IsUnionRule | 是 | 否 | Int64 | 是否为与关系策略 示例值: |
ProjectID | 是 | 否 | Int64 | 项目ID 示例值: |
Conditions | 是 | 是 | Array of Condition | 告警规则 示例值:查看 |
ConditionsTemp | 是 | 是 | DescribePolicyInfoByInstanceConditionsTemp | 规则模板信息 示例值:查看 |
InstanceGroup | 是 | 是 | DescribePolicyInfoByInstanceInstanceGroup | 实例组 示例值:查看 |
NoShieldedSum | 是 | 否 | Int64 | 未屏蔽实例数 示例值: |
UseSum | 是 | 否 | Int64 | 实例总数 示例值: |
UpdateTime | 是 | 否 | Int64 | 更新时间 示例值: |
InsertTime | 是 | 否 | Int64 | 创建时间 示例值: |
DescribeDashboardsList
DescribeDashboardsList
被如下接口引用:DescribeDashboards
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
DashboardID | 是 | 否 | String | DashboardID 示例值: |
DescName | 是 | 否 | String | 描述名称 示例值: |
Meta | 是 | 否 | String | 元数据 示例值: |
DescribeEventPolicyConfigDimension
DescribeEventPolicyConfigDimension
被如下接口引用:DescribeEventPolicyConfig
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | String | 维度名称 示例值: |
Key | 是 | 否 | String | 维度key值 示例值: |
DescribePolicyQuotaV3ResponseDataQuota
DescribePolicyQuotaV3ResponseDataQuota
被如下接口引用:DescribePolicyQuota
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Used | 是 | 否 | Int64 | 用户 示例值: |
Total | 是 | 否 | Int64 | 总数 示例值: |
DescribeAlarmCallbackHistory
历史回调信息
被如下接口引用:DescribeAlarmCallbackHistory
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Url | 是 | 否 | String | 回调地址 示例值: |
ValidFlag | 是 | 否 | Int64 | 回调是否验证 示例值: |
VerifyCode | 是 | 否 | 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 | 维度列表 示例值: |
IdcInfo
IdcInfo
被如下接口引用:DescribeIdcServerCount
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
IdcId | 是 | 否 | Int64 | 地域ID 示例值: |
ServerCount | 是 | 否 | Int64 | 实例数 示例值: |
IdcName | 是 | 否 | String | 地域名称 示例值: |
Contact
DescribeContactList接口返回的接收人信息
被如下接口引用:DescribeContactList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Uid | 是 | 否 | Int64 | uid 示例值: |
Uin | 是 | 否 | String | uin 示例值: |
Name | 是 | 否 | String | 接收人名称 示例值: |
CanLogin | 是 | 否 | Int64 | 是否可登录,0表示不可登录,1表示可登录 示例值: |
PhoneFlag | 是 | 否 | Int64 | 手机号是否验证通过 示例值: |
PhoneNum | 是 | 否 | String | 手机号 示例值: |
EmailFlag | 是 | 否 | Int64 | 邮箱是否验证通过 示例值: |
是 | 否 | String | 邮箱号 示例值: |
|
IsReceiverOwner | 是 | 否 | Int64 | 是否是接收负责人 示例值: |
OwnerUid | 是 | 否 | Int64 | ownerUid 示例值: |
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 示例值: |
ClmDescribeMetricSetsData
DescribeMetricSets 返回数据
被如下接口引用:DescribeMetricSets
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MetricSets | 是 | 是 | Array of ClmMetricSet | 指标集列表数据 示例值:查看 |
TotalCount | 是 | 否 | Int64 | 总数 示例值: |
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 | 属性唯一字符串,字母、数字、横杠或下划线组成 示例值: |
PCLMAnalysisFilter
CLM多维分析中的过滤条件
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Field | 是 | 否 | String | 字段名 示例值: |
Operator | 是 | 否 | String | 运算符 目前只支持 = (当value数组为多个值时为in关系) 示例值: |
Value | 是 | 否 | Array of String | 值 示例值: |
DescribePolicyInfoByInstanceConditionsTemp
DescribePolicyInfoByInstanceConditionsTemp
被如下接口引用:DescribePolicyInfoByInstance
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupID | 是 | 是 | Int64 | 组ID 示例值: |
GroupName | 是 | 否 | String | 组名 示例值: |
ViewName | 是 | 否 | String | 视图名 示例值: |
Remark | 是 | 否 | String | 备注 示例值: |
LastEditUin | 是 | 是 | Int64 | 最后编辑者UIN 示例值: |
IsUnionRule | 是 | 是 | Int64 | 是否为与关系 示例值: |
InsertTime | 是 | 是 | Int64 | 创建时间 示例值: |
UpdateTime | 是 | 是 | Int64 | 更新时间 示例值: |
CCMInstanceAttributeDataOutput
CCMInstanceAttributeDataOutput
被如下接口引用:DescribeCCMInstanceDatas
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AttributeId | 是 | 否 | Uint64 | 指标ID 示例值: |
ServerId | 是 | 否 | Uint64 | 服务器ID 示例值: |
Values | 是 | 否 | Array of AttributeTimestampValueOutput | 指标上报数据 示例值:查看 |
InstanceName | 是 | 否 | 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 | 更新时间(只作出参,入参不填) 示例值: |
CustomMetisAbnormlInput
自定义监控智能检测
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ViewId | 是 | 否 | Uint64 | 自定义监控视图ID 示例值: |
AttrId | 是 | 否 | Array of Uint64 | 自定义监控属性ID 示例值: |
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 | 日志数据结构描述 示例值:查看 |
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 | 复合指标表达式 (基础指标传空) 示例值: |
DescribeDashboardViewList
DescribeDashboardViewList
被如下接口引用:DescribeDashboardViews
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ViewID | 是 | 否 | Int64 | 视图ID 示例值: |
DescName | 是 | 否 | String | 描述名 示例值: |
Namespace | 是 | 否 | String | 名字空间 示例值: |
MetricName | 是 | 是 | Array of String | 指标名列表 示例值: |
Meta | 是 | 否 | String | 元数据json 示例值: |
Instances | 是 | 是 | Array of String | 实例列表 示例值: |
DescribeSortObjectListDimension
DescribeSortObjectList接口的Dimension,表示维度,包括维度名和维度值
被如下接口引用:DescribeSortObjectList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | String | 维度名 示例值: |
Value | 是 | 否 | String | 维度值 示例值: |
ModifyRecoverNotifyBatchNotifyInfo
ModifyRecoverNotifyBatch恢复方式信息
被如下接口引用:ModifyRecoverNotifyBatch
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupId | 是 | 否 | Int64 | 策略组id 示例值: |
RecoverNotify | 是 | 否 | Array of String | 告警恢复通知方式列表 示例值: |
CreatePolicyGroupCondition
创建策略传入的阈值告警条件
被如下接口引用:CreatePolicyGroup
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MetricId | 是 | 否 | Int64 | 指标Id 示例值: |
CalcType | 否 | 否 | Int64 | 比较类型,1表示大于,2表示大于等于,3表示小于,4表示小于等于,5表示相等,6表示不相等。如果指标有配置默认比较类型值可以不填。 示例值: |
CalcValue | 否 | 否 | Float | 比较的值,如果指标不必须CalcValue可不填 示例值: |
CalcPeriod | 否 | 否 | Int64 | 数据聚合周期(单位秒),若指标有默认值可不填 示例值: |
ContinuePeriod | 否 | 否 | Int64 | 持续几个检测周期触发规则会告警 示例值: |
AlarmNotifyType | 是 | 否 | Int64 | 告警发送收敛类型。0连续告警,1指数告警 示例值: |
AlarmNotifyPeriod | 是 | 否 | Int64 | 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次 示例值: |
RuleId | 否 | 否 | Int64 | 如果通过模版创建,需要传入模版中该指标的对应RuleId 示例值: |
DataPoint
监控数据点
被如下接口引用:GetMonitorData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Dimensions | 是 | 否 | Array of Dimension | 实例对象维度组合 示例值:查看 |
Timestamps | 是 | 否 | Array of Float | 时间戳数组,表示那些时间点有数据,缺失的时间戳,没有数据点,可以理解为掉点了 示例值: |
Values | 是 | 否 | Array of Float | 监控值数组,该数组和Timestamps一一对应 示例值: |
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 示例值: |
ProductSimple
云监控支持的产品简要信息
被如下接口引用:DescribeProductList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Namespace | 是 | 否 | String | 命名空间 示例值: |
ProductName | 是 | 否 | String | 产品中文名称 示例值: |
ProductEnName | 是 | 否 | String | 产品英文名称 示例值: |
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列表 示例值: |
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列表 示例值: |
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 示例值: |
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 示例值: |
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 示例值: |
AttributeUnitInfoOutputData
AttributeUnitInfoOutputData
被如下接口引用:DescribeAttributeUnits
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Data | 是 | 否 | Array of AttributeUnitInfoOutput | 属性单位数据列表 示例值:查看 |
TotalCount | 是 | 否 | Int64 | 属性单位数据列表个数 示例值: |
DescribeMonitorProductsProductMetaAlarm
DescribeMonitorProducts.productList.meta.alarm
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Dimensions | 是 | 是 | String | 指标告警维度 示例值: |
EventDimensions | 是 | 是 | String | 事件告警维度 示例值: |
PolicyViewName | 是 | 否 | String | 告警策略视图名称 示例值: |
ArgusDimensionOut
Argus维度字段
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Id | 是 | 否 | Uint64 | Id 示例值: |
NamespaceId | 是 | 否 | Uint64 | namespace的Id 示例值: |
EnName | 是 | 是 | String | 英文名 示例值: |
CnName | 是 | 是 | String | 中文名 示例值: |
CreateUin | 是 | 否 | String | 创建人 示例值: |
CreateTime | 是 | 否 | Uint64 | 创建的时间戳 示例值: |
UpdateUin | 是 | 否 | String | 更新人 示例值: |
UpdateTime | 是 | 否 | Uint64 | 更新的时间戳 示例值: |
MessagePolicy
MessagePolicy
被如下接口引用:DescribeMsgPolicyList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
PolicyID | 是 | 否 | String | 策略ID 示例值: |
PolicyName | 是 | 否 | String | 策略名 示例值: |
ReceiverGroupIds | 是 | 是 | Array of Int64 | 接收组ID列表 示例值: |
NotifyWay | 是 | 是 | Array of String | 通知方式 示例值: |
VoiceConfig | 是 | 是 | DescribeMsgPolicyListVoiceConfig | 语音配置 示例值:查看 |
IsDefault | 是 | 否 | Bool | 是否为默认策略 示例值: |
AlarmCount | 是 | 否 | Int64 | 告警次数 示例值: |
ServiceInfo
ServiceInfo
被如下接口引用:CreateService、DescribeService
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ServiceId | 是 | 是 | Int64 | 服务ID 示例值: |
IsOpen | 是 | 是 | Int64 | 是否开通服务 示例值: |
ViewId | 是 | 是 | Int64 | 默认视图ID 示例值: |
DescribeEventPolicyConfig
DescribeEventPolicyConfig
被如下接口引用:DescribeEventPolicyConfig
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
EventID | 是 | 否 | String | 事件ID 示例值: |
ProductName | 是 | 否 | String | 产品名 示例值: |
ProductEName | 是 | 否 | String | 产品英文名 示例值: |
ProductCName | 是 | 否 | String | 产品中文名 示例值: |
EventName | 是 | 否 | String | 事件名 示例值: |
EventEName | 是 | 否 | String | 事件英文名 示例值: |
EventCName | 是 | 否 | String | 事件中文名 示例值: |
Dimensions | 是 | 是 | Array of DescribeEventPolicyConfigDimension | 维度 示例值:查看 |
ArgusAggType
Argus聚合方式
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AggType | 是 | 否 | String | 聚合方式 示例值: |
Description | 是 | 否 | String | 描述 示例值: |
MetricObjectMeaning
指标数据的解释
被如下接口引用:DescribeBaseMetrics
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
En | 是 | 否 | String | 指标英文解释 示例值: |
Zh | 是 | 否 | String | 指标中文解释 示例值: |
BindingPolicyObjectDimension
策略绑定实例维度信息
被如下接口引用:BindingPolicyObject、CreateInstanceGroup、DescribeInstanceGroup、ModifyInstanceGroup、ShieldPolicyAlarm
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
RegionId | 否 | 否 | Int64 | 地域ID 示例值: |
Region | 是 | 否 | String | 地域名 示例值: |
Dimensions | 否 | 否 | String | 维度信息 示例值: |
EventDimensions | 否 | 否 | String | 事件维度信息 示例值: |
MetricTooltip
指标的富文本提示语
被如下接口引用:DescribeAlarmEvents、DescribeAlarmHistories、DescribeAlarmMetrics、DescribeMiniDashboardAlarmInfo
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Message | 是 | 否 | String | 文本内容 示例值: |
URL | 是 | 否 | String | 详情链接 示例值: |
UrlName | 是 | 否 | String | 链接名称 示例值: |
DescribePolicyGroupInfoReceiverInfo
查询策略输出的告警接收人信息
被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ReceiverGroupList | 是 | 否 | Array of Int64 | 告警接收组id列表 示例值: |
ReceiverUserList | 是 | 否 | Array of Int64 | 告警接收人id列表 示例值: |
StartTime | 是 | 否 | Int64 | 告警时间段开始时间。范围[0,86400),作为unix时间戳转成北京时间后去掉日期,例如7200表示"10:0:0" 示例值: |
EndTime | 是 | 否 | Int64 | 告警时间段结束时间。含义同StartTime 示例值: |
ReceiverType | 是 | 否 | String | 接收类型。“group”(接收组)或“user”(接收人) 示例值: |
NotifyWay | 是 | 否 | Array of String | 告警通知方式。可选 "SMS","SITE","EMAIL","CALL","WECHAT" 示例值: |
UidList | 是 | 是 | Array of Int64 | 电话告警接收者uid 示例值: |
RoundNumber | 是 | 否 | Int64 | 电话告警轮数 示例值: |
RoundInterval | 是 | 否 | Int64 | 电话告警每轮间隔(秒) 示例值: |
PersonInterval | 是 | 否 | Int64 | 电话告警对个人间隔(秒) 示例值: |
NeedSendNotice | 是 | 否 | Int64 | 是否需要电话告警触达提示。0不需要,1需要 示例值: |
SendFor | 是 | 否 | Array of String | 电话告警通知时机。可选"OCCUR"(告警时通知),"RECOVER"(恢复时通知) 示例值: |
RecoverNotify | 是 | 否 | Array of String | 恢复通知方式。可选"SMS" 示例值: |
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 | 更新时间 示例值: |
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 示例值: |
AttributeUnitInfoOutput
AttributeUnitInfoOutput
被如下接口引用:DescribeAttributeUnits
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
UnitId | 是 | 否 | Uint64 | 指标单位ID 示例值: |
UnitName | 是 | 否 | String | 指标单位名称 示例值: |
PCLMMetricAnalysisPoint
CLM指标分析数据点
被如下接口引用:DescribeMetricAnalysisData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Timestamp | 是 | 否 | Int64 | 时间戳(秒) 示例值: |
Value | 是 | 是 | Float | 值 示例值: |
Name | 是 | 否 | String | 指标名 示例值: |
AlarmPolicyQuota
告警2.0策略具体配额
被如下接口引用:DescribeAlarmObjectQuota、DescribeAlarmPolicyQuota
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AppId | 是 | 否 | Int64 | 账号ID 示例值: |
Namespace | 是 | 否 | String | 策略类型 ""=无策略类型 示例值: |
ProjectId | 是 | 否 | Int64 | 项目 Id -1=无项目 示例值: |
Total | 是 | 否 | Int64 | 配额总数 示例值: |
Used | 是 | 否 | Int64 | 已使用量 示例值: |
CommonNamespace
统一的命名空间信息
被如下接口引用:DescribeAllNamespaces
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Id | 是 | 否 | String | 命名空间标示 示例值: |
Name | 是 | 否 | String | 命名空间名称 示例值: |
Value | 是 | 否 | String | 命名空间值 示例值: |
ProductName | 是 | 否 | String | 产品名称 示例值: |
Config | 是 | 否 | String | 配置信息 示例值: |
AvailableRegions | 是 | 否 | Array of String | 支持地域列表 示例值: |
SortId | 是 | 否 | Int64 | 排序Id 示例值: |
DashboardId | 是 | 否 | String | Dashboard中的唯一表示 示例值: |
DescribePolicyUseList
DescribePolicyUseList返回的对象
被如下接口引用:DescribePolicyUseList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
UniqueId | 是 | 否 | String | 告警对象唯一id 示例值: |
Dimensions | 是 | 否 | String | 维度字符串 示例值: |
AlarmPolicyCondition
告警策略指标触发条件
被如下接口引用:CreateAlarmPolicy、DescribeAlarmPolicies、DescribeAlarmPolicy、ModifyAlarmPolicyCondition
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
IsUnionRule | 是 | 否 | String | 指标触发与或条件,0=或,1=与 示例值: |
Rules | 是 | 否 | Array of AlarmPolicyRule | 告警触发条件列表 示例值:查看 |
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 | 持续多长时间触发规则会告警(单位秒) 示例值: |
StrategyStatesInfo
StrategyStatesInfo
被如下接口引用:ModifyStrategyStates
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
StrategyId | 是 | 否 | Int64 | 告警策略ID 示例值: |
IsStart | 是 | 否 | Int64 | 启停状态。默认为1。 0:停止中, 1:启动中 示例值: |
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 示例值: |
CCMDashboardData
自定义监控 CCMDashboardData
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Data | 是 | 否 | Array of CCMDashboardEntry | 返回数据列表 示例值:查看 |
TotalCount | 是 | 否 | Int64 | 查询数据总数 示例值: |
TemplateTag
DescribeTemplateTags出参模板变量的标签列表
被如下接口引用:DescribeTemplateTags
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Tag | 是 | 否 | String | 标签名 示例值: |
TagType | 是 | 否 | String | 标签类型 示例值: |
ProductId | 是 | 否 | String | 关联的产品ID(基础监控) 示例值: |
AlarmEvent
告警事件
被如下接口引用:DescribeAlarmEvents
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
EventName | 是 | 否 | String | 事件名 示例值: |
Description | 是 | 否 | String | 展示的事件名 示例值: |
Namespace | 是 | 否 | String | 告警策略类型 示例值: |
Tooltip | 是 | 是 | MetricTooltip | 可用于展示的提示信息 示例值:查看 |
AlarmPolicyFilter
告警策略过滤条件
被如下接口引用:CreateAlarmPolicy、DescribeAlarmPolicies、DescribeAlarmPolicy、ModifyAlarmPolicyCondition
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Type | 是 | 否 | String | 过滤条件类型 DIMENSION=使用 Dimensions 做过滤 示例值: |
Expression | 否 | 否 | String | 裸写过滤表达式 示例值: |
Dimensions | 否 | 否 | String | AlarmPolicyDimension 二维数组序列化后的json字符串,一维数组之间互为或关系,一维数组内的元素互为与关系 示例值: |
DescribePolicyConditionListConfigManual
DescribePolicyConditionList.ConfigManual
被如下接口引用:DescribePolicyConditionList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
CalcType | 是 | 是 | DescribePolicyConditionListConfigManualCalcType | 检测方式 示例值:查看 |
CalcValue | 是 | 是 | DescribePolicyConditionListConfigManualCalcValue | 检测阈值 示例值:查看 |
ContinueTime | 是 | 是 | DescribePolicyConditionListConfigManualContinueTime | 持续时间 示例值:查看 |
Period | 是 | 是 | DescribePolicyConditionListConfigManualPeriod | 数据周期 示例值:查看 |
PeriodNum | 是 | 是 | DescribePolicyConditionListConfigManualPeriodNum | 持续周期个数 示例值:查看 |
StatType | 是 | 是 | DescribePolicyConditionListConfigManualStatType | 聚合方式 示例值:查看 |
MonitorSelectedDimension
已选择维度
被如下接口引用:DescribeDashboardDimensionValues
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
DimensionName | 否 | 否 | String | 维度名 示例值: |
DimensionValue | 否 | 否 | String | 维度值 示例值: |
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的链接信息"{ "esVersion": 5, "logLevelField": "","logMessageField": "", "maxConcurrentShardRequests": 256, "timeField": "@timestamp"}" 示例值: |
ReadOnly | 是 | 否 | Bool | 数据源数据是否只读 示例值: |
DescribeStorageDurationData
DescribeStorageDurationData
被如下接口引用:DescribeStorageDuration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Period | 是 | 否 | Int64 | 周期 示例值: |
Duration | 是 | 否 | Int64 | 持续时间 示例值: |
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 | 过滤操作值 示例值: |
MidQueryCondition
DescribeMidDimensionValueList的查询条件
被如下接口引用:DescribeMidDimensionValueList、DescribeStatisticData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Key | 是 | 否 | String | 维度 示例值: |
Operator | 是 | 否 | String | 操作符,支持等于(eq)、不等于(ne),以及in 示例值: |
Value | 是 | 否 | Array of String | 维度值,当Op是eq、ne时,只使用第一个元素 示例值: |
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 | 后缀 示例值: |
ModifyConditionsTemplateRequestEventCondition
ModifyConditionsTemplateRequestEventCondition
被如下接口引用:CreateConditionsTemplate、ModifyConditionsTemplate
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AlarmNotifyPeriod | 是 | 否 | String | 告警通知周期 示例值: |
AlarmNotifyType | 是 | 否 | String | 告警通知方式 示例值: |
EventID | 是 | 否 | String | 事件ID 示例值: |
RuleID | 否 | 否 | Int64 | 规则ID 示例值: |
DescribeGraphDataPartition
DescribeGraphDataPartition
被如下接口引用:DescribeGraphData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | Array of String | 分区名 示例值: |
Usage | 是 | 否 | Float | 用量 示例值: |
Total | 是 | 否 | Float | 总量 示例值: |
DescribeProductEventListEventsGroupInfo
DescribeProductEventList返回的Events里的GroupInfo
被如下接口引用:DescribeProductEventList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupId | 是 | 是 | Int64 | 策略ID 示例值: |
GroupName | 是 | 是 | String | 策略名 示例值: |
Dimensions
实例对象的维度组合
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | String | 实例维度名称 示例值: |
Value | 是 | 否 | String | 实例维度值 示例值: |
ModifyNotifyBatchNotifyInfo
ModifyNotifyBatch接口的告警通知方式
被如下接口引用:ModifyNotifyBatch
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupId | 是 | 否 | Int64 | 策略组id 示例值: |
NotifyWay | 是 | 否 | Array of 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 | 类型 示例值: |
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 | 指标英文描述,唯一名称 示例值: |
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:标签不存在 示例值: |
NameTypeBak
NameType
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | String | name 示例值: |
DescribeBindingPolicyObjectListDimension
DescribeBindingPolicyObjectList接口的Dimension
被如下接口引用:DescribeBindingPolicyObjectList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
RegionId | 是 | 否 | Int64 | 地域id 示例值: |
Region | 是 | 否 | String | 地域简称 示例值: |
Dimensions | 是 | 否 | String | 维度组合json字符串 示例值: |
EventDimensions | 是 | 否 | String | 事件维度组合json字符串 示例值: |
SubscribeInfoReceiver
DescribeSubscribeInfo出参
被如下接口引用:DescribeSubscribeInfo
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Username | 是 | 是 | String | 用户名 示例值: |
Uin | 是 | 是 | String | 用户Uin 示例值: |
Uid | 是 | 是 | String | 用户Uid 示例值: |
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 | 维度描述信息 示例值:查看 |
PCLMMetricAnalysisData
Clm指标分析data结构
被如下接口引用:DescribeMetricAnalysisData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Compare | 是 | 是 | Array of PCLMMetricAnalysisPoint | 对比数据 示例值:查看 |
Current | 是 | 是 | Array of PCLMMetricAnalysisPoint | 当前数据 示例值:查看 |
Granularity | 是 | 是 | Int64 | 时间粒度 (秒) 示例值: |
CustomAlarmList
CustomAlarmList
被如下接口引用:DescribeCustomAlarmList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
LocalIP | 是 | 否 | String | IP 示例值: |
Msg | 是 | 否 | String | 消息 示例值: |
OccurTime | 是 | 否 | String | 发生时间 示例值: |
Caller | 是 | 否 | String | 调用方 示例值: |
GroupIdTag
1.0策略ID、标签
被如下接口引用:DescribeGroupIDByTags
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupIDList | 是 | 否 | Array of String | 1.0策略ID 示例值: |
Key | 是 | 否 | String | 标签Key 示例值: |
Value | 是 | 否 | String | 标签Value 示例值: |
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表示且规则(所有规则都满足阈值条件才告警) 示例值: |
MoveFailReason
移动dashboard失败原因
被如下接口引用:MoveUnifyDashboards
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
UUID | 是 | 否 | String | dashboard的uuid 示例值: |
Msg | 是 | 否 | String | 移动失败原因 示例值: |
DescribeAlarmSmsQuotaQuota
DescribeAlarmSmsQuota接口的配额信息
被如下接口引用:DescribeAlarmSmsQuota
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Type | 是 | 否 | String | 配额类型 示例值: |
Name | 是 | 否 | String | 配额名称 示例值: |
FreeLeft | 是 | 否 | Int64 | 免费配额剩余量 示例值: |
PurchaseLeft | 是 | 否 | Int64 | 付费配额剩余量 示例值: |
Used | 是 | 否 | Int64 | 已使用量 示例值: |
PCLMMetricAnalysisCustomMetric
CLM指标分析中的复合指标参数
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 否 | 否 | String | 复合指标名 示例值: |
Formula | 是 | 否 | String | 运算表达式 示例值: |
PCLMStatisticFilterRule
日志监控指标集配置 指标过滤条件
被如下接口引用:CLMDescribeMetricSets
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MetricItemId | 否 | 是 | Int64 | 关联指标条目ID(只做出参,入参不填) 示例值: |
CreatedAt | 否 | 是 | String | 创建时间(只做出参,入参不填) 示例值: |
UpdatedAt | 否 | 是 | String | 更新时间(只做出参,入参不填) 示例值: |
Relation | 是 | 否 | Int64 | 关系 1AND 2OR 示例值: |
Field | 是 | 否 | String | 字段名 示例值: |
Operator | 是 | 否 | String | 过滤操作符: 数字型字段支持:gt lt ge le eq ne in 字符型字段支持:eq ne in contains 示例值: |
Value | 是 | 否 | String | 过滤操作值 示例值: |
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 示例值:查看 |
ModifyMsgPolicyVoiceConfig
自定义消息语音告警配置
被如下接口引用:CreateMsgPolicy、ModifyMsgPolicy
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
UidList | 否 | 否 | Array of Int64 | uid列表 示例值: |
RoundNumber | 否 | 否 | Int64 | 告警轮数, 1到5之间 示例值: |
RoundInterval | 否 | 否 | Int64 | 每轮告警之间的时间间隔, 单位秒 示例值: |
PersonInterval | 否 | 否 | Int64 | 每个人之间的时间间隔, 单位秒 示例值: |
NeedSendNotice | 否 | 否 | Int64 | 是否需要通知, 1表示需要, 0表示不需要 示例值: |
DashboardMetricCondition
Dashboard2.0指标查询时的查询条件
被如下接口引用:DescribeDashboardMetricData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Dimension | 是 | 否 | Array of String | 数组元素为json序列化字符串 示例值: |
Region | 是 | 否 | String | 域名名称,如:ap-guangzhou 示例值: |
ArgusOverviewNamespaceOut
Argus概览页的Namespace
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Namespace | 是 | 否 | String | Namespace的名称 示例值: |
Description | 是 | 是 | String | Namespace的描述 示例值: |
DataTimeLimit | 是 | 否 | String | 数据最大保存时间,单位天 示例值: |
DataDiskLimit | 是 | 否 | String | 数据最大存储容量,单位GB 示例值: |
DiskUsage | 是 | 否 | String | 已使用存储容量,单位GB 示例值: |
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 | 更新的时间戳 示例值: |
DescribePolicyGroupInfoConditionTpl
查询策略输出的模板策略组信息
被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupId | 是 | 否 | Int64 | 策略组id 示例值: |
GroupName | 是 | 否 | String | 策略组名称 示例值: |
ViewName | 是 | 否 | String | 策略类型 示例值: |
Remark | 是 | 否 | String | 策略组说明 示例值: |
LastEditUin | 是 | 否 | String | 最后编辑的用户uin 示例值: |
UpdateTime | 是 | 是 | Int64 | 更新时间 示例值: |
InsertTime | 是 | 是 | Int64 | 创建时间 示例值: |
IsUnionRule | 是 | 是 | Int64 | 是否且规则 示例值: |
InstanceGroup
DescribeBasicAlarmList返回的Alarms里的InstanceGroup
被如下接口引用:DescribeBasicAlarmList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceGroupId | 是 | 是 | Int64 | 实例组ID 示例值: |
InstanceGroupName | 是 | 是 | String | 实例组名 示例值: |
DimensionsDesc
维度信息
被如下接口引用:DescribeBaseMetrics
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Dimensions | 是 | 否 | Array of String | 维度名数组 示例值: |
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 示例值: |
ArgusDimensionIn
Argus维度字段
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
EnName | 是 | 否 | String | 英文名 示例值: |
CnName | 是 | 否 | String | 中文名 示例值: |
ClmLogProfileItem
日志监控指标集-日志数据结构描述
被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Id | 否 | 否 | Int64 | id(只做出参,入参不填) 示例值: |
MetricSetId | 否 | 否 | Int64 | 关联指标集ID(只做出参,入参不填) 示例值: |
Field | 是 | 否 | String | 字段名 示例值: |
Type | 是 | 否 | String | 字段类型,可选:string、long、double 示例值: |
CreatedAt | 否 | 否 | String | 创建时间(只做出参,入参不填) 示例值: |
UpdatedAt | 否 | 否 | String | 更新时间(只做出参,入参不填) 示例值: |
ServerAttributeDataOutput
ServerAttributeDataOutput
被如下接口引用:DescribeServerDatas
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AttributeId | 是 | 否 | Uint64 | 指标ID 示例值: |
ServerId | 是 | 否 | Uint64 | 服务器ID 示例值: |
Values | 是 | 否 | Array of AttributeTimestampValueOutput | 指标上报值 示例值:查看 |
AttributeAggrValueInfoOutputData
AttributeAggrValueInfoOutputData
被如下接口引用:DescribeAttributeAggregateData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Data | 是 | 否 | Array of AttributeTimestampValueOutput | 返回聚合数据列表 示例值:查看 |
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 示例值: |
DescribePolicyQuotaV3ResponseData
DescribePolicyQuotaV3ResponseData
被如下接口引用:DescribePolicyQuota
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ViewName | 是 | 否 | String | 视图 示例值: |
IsQuotaByProject | 是 | 否 | Bool | 是否为项目配额 示例值: |
QuotaList | 是 | 是 | Array of DescribePolicyQuotaV3ResponseDataQuotaList | 配额列表 示例值:查看 |
Quota | 是 | 是 | DescribePolicyQuotaV3ResponseDataQuota | 配额 示例值:查看 |
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 | 指标单位 示例值: |
AttributeServerInfoOutput
AttributeServerInfoOutput
被如下接口引用:DescribeAttributeAllServer、DescribeIdcServer
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ServerId | 是 | 是 | Uint64 | 服务器ID 示例值: |
ServerName | 是 | 是 | String | 服务器名称 示例值: |
Ip | 是 | 是 | String | 服务器ip 示例值: |
IdcId | 是 | 是 | Int64 | 地域ID 示例值: |
IdcName | 是 | 是 | String | 地域名称 示例值: |
RegionPolicyObjectCount
DescribePolicyObjectCount接口返回的地域统计
被如下接口引用:DescribePolicyObjectCount
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Region | 是 | 否 | String | 地域 示例值: |
Count | 是 | 否 | Int64 | 绑定的实例数量 示例值: |
DashboardPanel
dashboard的panel
被如下接口引用:AddDashboardPanels、TopDashboardPanel
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Type | 否 | 否 | String | copy |
DashboardUUID | 否 | 否 | String | dashboard的UUID 示例值: |
PanelID | 否 | 否 | Int64 | panel的ID 示例值: |
Panel | 否 | 否 | String | panel数据 示例值: |
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 | 复合指标表达式 (基础指标传空) 示例值: |
ModifyPolicyGroupEventCondition
修改告警策略组传入的事件告警条件
被如下接口引用:ModifyPolicyGroup
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
RuleId | 否 | 否 | Int64 | 规则id,不填表示新增,填写了ruleId表示在已存在的规则基础上进行修改 示例值: |
EventId | 是 | 否 | Int64 | 事件id 示例值: |
AlarmNotifyType | 是 | 否 | Int64 | 告警发送收敛类型。0连续告警,1指数告警 示例值: |
AlarmNotifyPeriod | 是 | 否 | Int64 | 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次 示例值: |
DescribeBindingPolicyObjectListInstance
查询策略绑定对象列表接口返回的对象实例信息
被如下接口引用:DescribeBindingPolicyObjectList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
UniqueId | 是 | 否 | String | 对象唯一id 示例值: |
Dimensions | 是 | 否 | String | 表示对象实例的维度集合,jsonObj字符串 示例值: |
IsShielded | 是 | 否 | Int64 | 对象是否被屏蔽,0表示未屏蔽,1表示被屏蔽 示例值: |
Region | 是 | 否 | String | 对象所在的地域 示例值: |
AttributeInfoOutputData
属性数据列表
被如下接口引用:DescribeAttributes
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Data | 是 | 否 | Array of AttributeInfoOutput | 属性数据列表 示例值:查看 |
TotalCount | 是 | 否 | Int64 | 属性数据列表个数 示例值: |
DescribeAgentStatusHistory
DescribeAgentStatusHistory
被如下接口引用:DescribeAgentStatusHistory
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Timestamp | 是 | 否 | Datetime_iso | 时间戳 示例值: |
Status | 是 | 否 | Int64 | 状态 示例值: |
DescribePolicySituationAlarmSituation
DescribePolicySituationAlarmSituation
被如下接口引用:DescribePolicySituation
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AlarmRuleCount | 是 | 否 | Int64 | 告警规则数 示例值: |
AlarmTouchCount | 是 | 否 | Int64 | 告警触达数 示例值: |
PolicyTag
策略标签
被如下接口引用:BindingPolicyTag、DescribeGroupIDByTags、UnbindingPolicyTag
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Key | 是 | 否 | String | 标签Key 示例值: |
Value | 是 | 否 | String | 标签Value 示例值: |
AttributeServerInfoOutputData
AttributeServerInfoOutputData
被如下接口引用:DescribeAttributeAllServer、DescribeIdcServer
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Data | 是 | 否 | Array of AttributeServerInfoOutput | 返回上报该属性的服务器列表 示例值:查看 |
TotalCount | 是 | 否 | Int64 | 返回上报该属性的服务器列表个数 示例值: |
AlarmPolicyTriggerTask
告警策略触发任务
被如下接口引用:CreateAlarmPolicy、DescribeAlarmPolicies、DescribeAlarmPolicy、ModifyAlarmPolicyTasks
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Type | 是 | 否 | String | 触发任务类型 AS=弹性伸缩 示例值: |
TaskConfig | 是 | 否 | String | 用 json 表示配置信息 {"Key1":"Value1","Key2":"Value2"} 示例值: |
DescribePolicyGroupInfoEventCondition
查询策略输出的事件告警条件
被如下接口引用:DescribePolicyGroupInfo、DescribePolicyGroupList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
EventId | 是 | 否 | Int64 | 事件id 示例值: |
RuleId | 是 | 否 | Int64 | 事件告警规则id 示例值: |
EventShowName | 是 | 否 | String | 事件名称 示例值: |
AlarmNotifyPeriod | 是 | 否 | Int64 | 告警发送周期单位秒。<0 不触发, 0 只触发一次, >0 每隔triggerTime秒触发一次 示例值: |
AlarmNotifyType | 是 | 否 | Int64 | 告警发送收敛类型。0连续告警,1指数告警 示例值: |
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或 示例值: |
DescribeAccidentConfigAccident
DescribeAccidentConfig接口的平台事件
被如下接口引用:DescribeAccidentConfig
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
BusinessId | 是 | 否 | Int64 | 业务id 示例值: |
BusinessName | 是 | 否 | String | 业务名称 示例值: |
BusinessEnName | 是 | 否 | String | 业务英文名称 示例值: |
PolicyShowName | 是 | 否 | String | 策略展示名称 示例值: |
PolicyShowEnName | 是 | 否 | String | 策略展示英文名称 示例值: |
PolicyViewName | 是 | 否 | String | 策略类型名称 示例值: |
AccidentTypeInfo | 是 | 否 | Array of DescribeAccidentConfigAccidentTypeInfo | 平台事件类型列表 示例值:查看 |
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 | 指标含义 示例值:查看 |
PCLMMetricCustomItem
日志监控指标集复合指标配置
被如下接口引用:CLMDescribeMetricSets
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Formula | 是 | 否 | String | 表达式 示例值: |
Name | 是 | 否 | String | 指标名 示例值: |
Desc | 是 | 否 | String | 指标描述中文名 示例值: |
MetricSetCID | 否 | 否 | String | 指标集CID(只作出参,入参不填) 示例值: |
CreatedAt | 否 | 否 | String | 创建时间(只作出参,入参不填) 示例值: |
UpdatedAt | 否 | 否 | String | 更新时间(只作出参,入参不填) 示例值: |
PCLMAlertFilterRule
CLM告警过滤条件
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AlertPolicyCID | 是 | 是 | String | 关联的告警策略CID 示例值: |
Key | 是 | 是 | String | 过滤的关键字 示例值: |
Operating | 是 | 是 | String | 操作符 示例值: |
Value | 是 | 是 | String | 筛选值(多个值逗号分隔) 示例值: |
CreatedAt | 是 | 是 | String | 创建时间 示例值: |
UpdatedAt | 是 | 是 | String | 更新时间 示例值: |
CCMChartData
CCMChartData
被如下接口引用:DescribeCCMCharts
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Data | 是 | 否 | Array of CCMChartEntry | 返回数据列表 示例值:查看 |
TotalCount | 是 | 否 | Int64 | 查询数据总数 示例值: |
DescribeProductEventListEventsDimensions
DescribeProductEventList返回的Events的Dimensions
被如下接口引用:DescribeProductEventList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Key | 是 | 是 | String | 维度名(英文) 示例值: |
Name | 是 | 是 | String | 维度名(中文) 示例值: |
Value | 是 | 是 | String | 维度值 示例值: |
GroupTemplateList
GetRecommendedTemplateResponse.GroupTemplateList
被如下接口引用:DescribeRecommendedTemplate
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
GroupID | 是 | 否 | Int64 | 模板策略組ID 示例值: |
GroupName | 是 | 否 | String | 模板策略组名称 示例值: |
IsDefault | 是 | 否 | Int64 | 是否为默认策略 示例值: |
Enable | 是 | 否 | Bool | 告警策略启用状态 示例值: |
LastEditUin | 是 | 否 | Int64 | 最后修改人UIN 示例值: |
NoShieldedInstanceCount | 是 | 否 | Int64 | 未屏蔽的实例数 示例值: |
TotalInstanceCount | 是 | 否 | Int64 | 总绑定实例数 示例值: |
ParentGroupID | 是 | 否 | Int64 | 父策略组ID 示例值: |
Remark | 是 | 否 | String | 备注信息 示例值: |
ViewName | 是 | 否 | String | 视图 示例值: |
Conditions | 是 | 否 | Array of Condition | 指标告警触发条件 示例值:查看 |
EventConditions | 是 | 否 | Array of EventCondition | 事件告警触发条件 示例值:查看 |
CanSetDefault | 是 | 否 | Bool | 是否可设为默认告警策略 示例值: |
InsertTime | 是 | 否 | Int64 | 创建时间 示例值: |
UpdateTime | 是 | 否 | Int64 | 修改时间 示例值: |
ClmAlertFilterRule
已失效
被如下接口引用:CreateAlertPolicy、DescribeAlertPolicies、DescribeAlertPolicy、ModifyAlertPolicy
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AlertPolicyId | 是 | 是 | Int64 | 关联的告警策略ID 示例值: |
Key | 是 | 是 | String | 过滤的关键字 示例值: |
Operating | 是 | 是 | String | 操作符 示例值: |
Value | 是 | 是 | String | 筛选值(多个值逗号分隔) 示例值: |
Id | 否 | 是 | Int64 | 过滤条件id 示例值: |
CreatedAt | 否 | 是 | String | 创建时间 示例值: |
UpdatedAt | 否 | 是 | String | 更新时间 示例值: |
WebStorageInfos
dashboard弹窗信息管理
被如下接口引用:DescribeWebStorage
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
CreatedAt | 是 | 否 | String | 创建时间 示例值: |
SubUin | 是 | 否 | String | 子用户 示例值: |
Uin | 是 | 否 | String | 主用户 示例值: |
UpdatedAt | 是 | 否 | String | 更新时间 示例值: |
WebStorageInfo | 是 | 否 | String | 弹窗信息 示例值: |
MonitorTypeInfo
监控类型详细信息
被如下接口引用:DescribeMonitorTypes
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Id | 是 | 否 | String | 监控类型ID 示例值: |
Name | 是 | 否 | String | 监控类型 示例值: |
SortId | 是 | 否 | Int64 | 排列顺序 示例值: |
AlarmBindingInstance
AlarmBindingInstance
被如下接口引用:DescribeAlarmBindingInstanceList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
UUID | 是 | 否 | String | 实例UUID 示例值: |
Information | 是 | 否 | String | 实例维度组合信息 示例值: |
MiniDashboardAlarmInfo
MiniDashboard AlarmInfo
被如下接口引用:DescribeMiniDashboardAlarmInfo
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Dimension | 否 | 否 | String | 维度信息 示例值: |
NoPolicy | 否 | 否 | Bool | 无告警策略 示例值: |
DefaultPolicyWithoutNotice | 否 | 否 | String | 没有通知规则的默认策略 示例值: |
ProductListForDescribeMonitorProducts
DescribeMonitorProducts 出参 ProductList 数组
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AvaliableRegions | 是 | 否 | Array of String | 支持的地域 示例值: |
Id | 是 | 否 | String | 产品的ID 示例值: |
IsShowInDashboard | 是 | 否 | Bool | 是否在Dashboard展示 示例值: |
Meta | 是 | 否 | String | JS配置 示例值: |
Namespace | 是 | 否 | String | 命名空间 示例值: |
PolicyViewName | 是 | 否 | String | 策略的视图名 示例值: |
ProductName | 是 | 否 | String | 产品名 示例值: |
DescribePolicyConditionListConfigManualPeriodNum
DescribePolicyConditionList.ConfigManual.PeriodNum
被如下接口引用:DescribePolicyConditionList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Default | 是 | 是 | Int64 | 默认周期数 示例值: |
Keys | 是 | 是 | Array of Int64 | 可选周期数 示例值: |
Need | 是 | 否 | Bool | 是否必须 示例值: |
IdcInfoData
IdcInfoData
被如下接口引用:DescribeIdcServerCount
PCLMLogProfileItem
日志监控指标集-日志数据结构描述
被如下接口引用:CLMDescribeMetricSets
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MetricSetCID | 否 | 否 | String | 关联指标集CID(只做出参,入参不填) 示例值: |
Field | 是 | 否 | String | 字段名 示例值: |
Type | 是 | 否 | String | 字段类型,可选:string、long、double 示例值: |
CreatedAt | 否 | 否 | String | 创建时间(只做出参,入参不填) 示例值: |
UpdatedAt | 否 | 否 | String | 更新时间(只做出参,入参不填) 示例值: |
ServerInfoData
ServerInfoData
被如下接口引用:DescribeServers
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Data | 是 | 否 | Array of ServerInfo | 返回数据 示例值:查看 |
TotalCount | 是 | 否 | Int64 | 总数 示例值: |
DescribePolicyConditionListMetric
指标告警配置
被如下接口引用:DescribePolicyConditionList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ConfigManual | 是 | 是 | DescribePolicyConditionListConfigManual | 指标配置 示例值:查看 |
MetricId | 是 | 否 | Int64 | 指标id 示例值: |
MetricShowName | 是 | 否 | String | 指标名称 示例值: |
MetricUnit | 是 | 否 | String | 指标单位 示例值: |
AlarmHistoryMetric
告警历史的指标信息
被如下接口引用:DescribeAlarmHistories、DescribeMiniDashboardAlarmInfo
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
QceNamespace | 是 | 否 | String | 查询数据使用的命名空间 示例值: |
MetricName | 是 | 否 | String | 指标名 示例值: |
Period | 是 | 否 | Int64 | 统计周期 示例值: |
Value | 是 | 否 | String | 触发告警的数值 示例值: |
Tooltip | 是 | 是 | MetricTooltip | 指标的解释 示例值:查看 |
Description | 是 | 否 | String | 指标的展示名 示例值: |
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 | 更新时间(只作出参,入参不填) 示例值: |
ViewIdOutput
ViewIdOutput
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ViewId | 是 | 是 | Uint64 | 视图ID 示例值: |
MetricAggregation
指标的聚合方式
被如下接口引用:DescribeAlarmMetrics
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
NameCn | 是 | 否 | String | 中文名 示例值: |
NameEn | 是 | 否 | String | 英文名 示例值: |
Id | 否 | 是 | String | Id 示例值: |
Name | 否 | 是 | String | Name 示例值: |
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 示例值: |
DashboardViewsInstances
DashboardViewsInstances
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
RegionID | 是 | 否 | String | 地域ID 示例值: |
UnInstanceID | 是 | 否 | String | 实例ID 示例值: |
AttributeIdOutput
AttributeIdOutput
被如下接口引用:ModifyAttribute
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AttributeId | 是 | 是 | Uint64 | 属性ID 示例值: |
MetricConfig
指标配置
被如下接口引用:DescribeAlarmMetrics
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Operator | 是 | 否 | Array of String | 允许使用的运算符 示例值: |
Period | 是 | 否 | Array of Int64 | 允许配置的数据周期,以秒为单位 示例值: |
ContinuePeriod | 是 | 否 | Array of Int64 | 允许配置的持续周期个数 示例值: |
Point
监控数据点
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Timestamp | 是 | 否 | Uint64 | 该监控数据点生成的时间点 示例值: |
Value | 是 | 否 | Float | 监控数据点的值 示例值: |
TransLogInstance
DescribeTransLog返回的实例List
被如下接口引用:DescribeInstanceGroup
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Dimensions | 是 | 是 | String | 实例Dimension 示例值: |
UniqueId | 是 | 是 | String | 实例UniqueID 示例值: |
IsShielded | 是 | 是 | Int64 | 屏蔽状态,1表示已屏蔽,0表示未屏蔽 示例值: |
Region | 是 | 是 | 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 示例值: |
DescribePolicyQuotaV3ResponseDataQuotaList
DescribePolicyQuotaV3ResponseDataQuotaList
被如下接口引用:DescribePolicyQuota
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Used | 是 | 否 | Int64 | 用户 示例值: |
Total | 是 | 否 | Int64 | 总数 示例值: |
ProjectID | 是 | 否 | Int64 | 项目ID 示例值: |
DescribePolicyConditionListConfigManualContinueTime
DescribePolicyConditionList.ConfigManual.ContinueTime
被如下接口引用:DescribePolicyConditionList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Default | 是 | 是 | Int64 | 默认持续时间,单位:秒 示例值: |
Keys | 是 | 是 | Array of Int64 | 可选持续时间,单位:秒 示例值: |
Need | 是 | 否 | Bool | 是否必须 示例值: |
Dimension
实例对象的维度组合
被如下接口引用:DescribeDashboardMetricData、DescribePolicyGroupCount、GetMonitorData、GetTkeData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | String | 实例维度名称 示例值: |
Value | 是 | 否 | String | 实例维度值 示例值: |
IdcData
IdcData
被如下接口引用:DescribeIdcTree
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Id | 是 | 否 | Int64 | idc id,在腾讯云上代表zoneId 示例值: |
Name | 是 | 否 | String | idc id,在腾讯云上代表zone名称 示例值: |
ModifyConditionsTemplateRequestCondition
ModifyConditionsTemplateRequestCondition
被如下接口引用:CreateConditionsTemplate、ModifyConditionsTemplate
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AlarmNotifyPeriod | 否 | 否 | String | 告警通知周期 示例值: |
AlarmNotifyType | 否 | 否 | Int64 | 告警通知方式 示例值: |
CalcPeriod | 是 | 否 | String | 统计周期 示例值: |
CalcType | 是 | 否 | String | 统计方式 示例值: |
CalcValue | 是 | 否 | String | 统计值 示例值: |
ContinuePeriod | 是 | 否 | String | 持续周期 示例值: |
MetricId | 是 | 否 | Int64 | 指标ID 示例值: |
RuleID | 否 | 否 | Int64 | 规则ID 示例值: |
AttributeIdDeleteOutput
AttributeIdDeleteOutput
被如下接口引用:DeleteAttribute、DeleteAttributes
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
DeleteCount | 是 | 否 | Int64 | 删除个数 示例值: |
AttributeId | 是 | 否 | Array of Uint64 | 属性ID 示例值: |
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列表。 示例值: |
ClmMetricCustomItem
日志监控指标集复合指标配置
被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Formula | 是 | 否 | String | 表达式 示例值: |
Name | 是 | 否 | String | 指标名 示例值: |
Desc | 是 | 否 | String | 指标描述中文名 示例值: |
Id | 否 | 否 | Int64 | 条目ID(只作出参,入参不填) 示例值: |
MetricSetId | 否 | 否 | Int64 | 指标集ID(只作出参,入参不填) 示例值: |
CreatedAt | 否 | 否 | String | 创建时间(只作出参,入参不填) 示例值: |
UpdatedAt | 否 | 否 | String | 更新时间(只作出参,入参不填) 示例值: |
ArgusMapOut
Argus通用Map
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | String | 名称 示例值: |
Values | 是 | 是 | Array of String | 值列表 示例值: |
PolicyGroup
策略组信息
被如下接口引用:DescribeConditionsTemplateList
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
CanSetDefault | 是 | 否 | Bool | 是否可设为默认告警策略 示例值: |
GroupID | 是 | 否 | Int64 | 告警策略组ID 示例值: |
GroupName | 是 | 否 | String | 告警策略组名称 示例值: |
InsertTime | 是 | 否 | Int64 | 创建时间 示例值: |
IsDefault | 是 | 否 | Int64 | 是否为默认告警策略 示例值: |
Enable | 是 | 否 | Bool | 告警策略启用状态 示例值: |
LastEditUin | 是 | 否 | Int64 | 最后修改人UIN 示例值: |
NoShieldedInstanceCount | 是 | 否 | Int64 | 未屏蔽的实例数 示例值: |
ParentGroupID | 是 | 否 | Int64 | 父策略组ID 示例值: |
ProjectID | 是 | 否 | Int64 | 所属项目ID 示例值: |
ReceiverInfos | 是 | 是 | Array of PolicyGroupReceiverInfo | 告警接收对象信息 示例值:查看 |
Remark | 是 | 否 | String | 备注信息 示例值: |
UpdateTime | 是 | 否 | Int64 | 修改时间 示例值: |
TotalInstanceCount | 是 | 否 | Int64 | 总绑定实例数 示例值: |
ViewName | 是 | 否 | String | 视图 示例值: |
IsUnionRule | 是 | 否 | Int64 | 是否为与关系规则 示例值: |
URLNotice
云监控告警通知模板 - 回调通知详情
被如下接口引用:CreateAlarmNotice、DescribeAlarmNotice、DescribeAlarmNoticeCallbacks、DescribeAlarmNotices、DescribeAlarmPolicies、DescribeAlarmPolicy、ModifyAlarmNotice
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
URL | 是 | 是 | String | 回调 url(限长256字符) 示例值: |
IsValid | 否 | 是 | Int64 | 是否通过验证 0=否 1=是 示例值: |
ValidationCode | 否 | 是 | String | 验证码 示例值: |
ClmDimension
日志监控指标集维度对象
被如下接口引用:CreateMetricSet、DescribeMetricSet、DescribeMetricSets、ModifyMetricSet
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Field | 是 | 否 | String | 字段名 示例值: |
Id | 否 | 否 | Int64 | 条目ID(只作出参,入参不填) 示例值: |
CreatedAt | 否 | 否 | String | 创建时间(只作出参,入参不填) 示例值: |
UpdatedAt | 否 | 否 | String | 更新时间(只作出参,入参不填) 示例值: |
MetricSetId | 否 | 否 | Int64 | 指标集ID(只作出参,入参不填) 示例值: |
DescribeBaseMetricsDataMeaning
DescribeBaseMetricsDataMeaning
被如下接口引用:DescribeBaseMetricsForConsoleFontEnd
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Language | 是 | 否 | String | 语言 示例值: |
Meaning | 是 | 否 | String | 含义 示例值: |
ClmMetricAnalysisCurrentData
CLM指标分析当前数据
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Current | 是 | 是 | Array of PCLMMetricAnalysisPoint | 当前数据 示例值:查看 |
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 |
AscDesc | 否 | 否 | String | 排序顺序,asc |
Limit | 否 | 否 | Uint64 | 排序个数 示例值: |
PCLMDescribeAlertPoliciesData
PCLMDescribeAlertPoliciesData
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
TotalCount | 是 | 是 | Int64 | 总数 示例值: |
AlertPolicies | 是 | 是 | Array of PCLMAlertPolicy | 列表元素 示例值:查看 |
DescribePolicyGroupInfoCallback
查询策略输出的用户回调信息
被如下接口引用:DescribePolicyGroupInfo
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
CallbackUrl | 是 | 否 | String | 用户回调接口地址 示例值: |
ValidFlag | 是 | 否 | Int64 | 用户回调接口状态,0表示未验证,1表示已验证,2表示存在url但没有通过验证 示例值: |
VerifyCode | 是 | 否 | String | 用户回调接口验证码 示例值: |
ClmMetricAnalysisBasicMetric
CLM指标分析中的基础指标参数
被如下接口引用:DescribeMetricAnalysisData
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Operator | 是 | 否 | String | 操作符 示例值: |
Name | 是 | 否 | String | 指标名 示例值: |
PCLMDimension
日志监控指标集维度对象
被如下接口引用:CLMDescribeMetricSets
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Field | 是 | 否 | String | 字段名 示例值: |
CreatedAt | 否 | 否 | String | 创建时间(只作出参,入参不填) 示例值: |
UpdatedAt | 否 | 否 | String | 更新时间(只作出参,入参不填) 示例值: |
MetricSetCID | 否 | 否 | String | 指标集CID(只作出参,入参不填) 示例值: |
PCLMMetricAnalysisBasicMetric
CLM指标分析中的基础指标参数
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Operator | 是 | 否 | String | 操作符 示例值: |
Name | 是 | 否 | String | 指标名 示例值: |
StrategyChannelInfo
StrategyChannelInfo
被如下接口引用:ModifyStrategyChannels
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
StrategyId | 是 | 否 | Uint64 | 告警策略ID 示例值: |
AlarmChannel | 否 | 否 | Array of String | 告警渠道列表 示例值: |
ArgusNamespaceOut
Argus的Namespace
被如下接口引用:
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | String | 名称 示例值: |
Description | 是 | 是 | String | 描述 示例值: |
DataTimeLimit | 是 | 否 | Uint64 | 数据最大保存时间,单位天 示例值: |
DataDiskLimit | 是 | 否 | Uint64 | 数据最大存储容量,单位GB 示例值: |
AdminUins | 是 | 是 | Array of String | 管理员列表 示例值: |
AggPeriod | 是 | 否 | Uint64 | 聚合周期 示例值: |
AppId | 是 | 否 | Uint64 | AppId 示例值: |
CreateUin | 是 | 否 | String | 创建人 示例值: |
CreateTime | 是 | 否 | Uint64 | 创建的时间戳 示例值: |
UpdateUin | 是 | 否 | String | 更新人 示例值: |
UpdateTime | 是 | 否 | Uint64 | 更新的时间戳 示例值: |
Id | 是 | 否 | Uint64 | Id 示例值: |