jdcloud_sdk.services.monitor.models package¶
Submodules¶
jdcloud_sdk.services.monitor.models.AddTagsSpec module¶
-
class
jdcloud_sdk.services.monitor.models.AddTagsSpec.AddTagsSpec(appCode, groupCode, resourceIds, serviceCode, srcServiceCode, tagK, tagV)[source]¶ Bases:
objectParameters: - appCode – 应用码。调用此API前需找云监控提供
- groupCode – 组id。须确保在一个APP范围内全局唯一
- resourceIds – 资源列表。总资源不能超过100个
- serviceCode – 资源的产品线
- srcServiceCode – 打标签操作所属产品线的serviceCode
- tagK – 标签名称。调用此API前需要与云监控确认可以使用的标签名称
- tagV – 标签值
jdcloud_sdk.services.monitor.models.Alarm module¶
jdcloud_sdk.services.monitor.models.AlarmHistoryWithDetail module¶
jdcloud_sdk.services.monitor.models.AlarmVo module¶
-
class
jdcloud_sdk.services.monitor.models.AlarmVo.AlarmVo(calculateUnit=None, calculation=None, contacts=None, createTime=None, deleted=None, downSample=None, id=None, metric=None, metricId=None, metricName=None, noticeLevel=None, noticePeriod=None, operation=None, period=None, ruleType=None, serviceCode=None, tag=None, tags=None, threshold=None, times=None, updateTime=None)[source]¶ Bases:
objectParameters: - calculateUnit – (Optional) 监控项单位
- calculation – (Optional) 统计方法:平均值=avg、最大值=max、最小值=min
- contacts – (Optional) 联系人列表
- createTime – (Optional)
- deleted – (Optional) 是否删除 1正常,0删除
- downSample – (Optional) downSample
- id – (Optional) 规则ID
- metric – (Optional) 监控项
- metricId – (Optional) 监控项ID
- metricName – (Optional) 监控项名称
- noticeLevel – (Optional)
- noticePeriod – (Optional) 通知周期
- operation – (Optional) 报警比较符,只能为以下几种lte(<=),lt(<),gt(>),gte(>=),eq(==),ne(!=)
- period – (Optional) 统计周期(单位:分钟)
- ruleType – (Optional) 规则类型
- serviceCode – (Optional) 规则所属资源类型
- tag – (Optional) 监控项附属信息
- tags – (Optional) 多值标签
- threshold – (Optional) 阈值
- times – (Optional) 连续多少次后报警
- updateTime – (Optional)
jdcloud_sdk.services.monitor.models.ApplyTemplateSpec module¶
jdcloud_sdk.services.monitor.models.BaseContact module¶
jdcloud_sdk.services.monitor.models.BaseRule module¶
-
class
jdcloud_sdk.services.monitor.models.BaseRule.BaseRule(calculateUnit, calculation, downSample, metric, noticePeriod, operation, period, threshold, times, autoScalingPolicyId=None, noticeLevel=None, ruleName=None, ruleType=None, tags=None)[source]¶ Bases:
objectParameters: - autoScalingPolicyId – (Optional) 弹性伸缩组ID
- calculateUnit – 单位
- calculation – 统计方法,必须与定义的metric一致,可选值列表:avg,sum,max,min
- downSample – 降采样函数
- metric – 监控项唯一标识,可根据DescribeMetricsForCreateAlarm接口查询各产品线可用的监控项(创建规则时使用Metric字段)。格式:metric:downsample
- noticeLevel – (Optional)
- noticePeriod – 通知周期,单位:小时
- operation – 报警比较符,只能为以下几种lte(<=),lt(<),gt(>),gte(>=),eq(==),ne(!=)
- period – 查询指标的周期,单位为分钟,目前支持的取值:1,2,5,10,15,30,60
- ruleName – (Optional) 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、’’-‘’和”_”
- ruleType – (Optional) 规则类型, 1云监控的规则, 6站点监控。默认为1
- tags – (Optional) 多值标签
- threshold – 报警阈值,目前只开放数值类型功能
- times – 连续探测几次都满足阈值条件时报警,可选值:1,2,3,5,10,15,30,60
jdcloud_sdk.services.monitor.models.BaseRuleT module¶
-
class
jdcloud_sdk.services.monitor.models.BaseRuleT.BaseRuleT(calculation, metric, noticePeriod, operation, period, ruleType, threshold, times, autoScalingPolicyId=None, calculateUnit=None, downSample=None, metricId=None, noticeLevel=None, tags=None)[source]¶ Bases:
objectParameters: - autoScalingPolicyId – (Optional) 弹性伸缩组ID
- calculateUnit – (Optional) 监控项单位
- calculation – 统计方法,必须与定义的metric一致,可选值列表:avg,sum,max,min
- downSample – (Optional) 降采样函数
- metric – 监控项唯一标识,可根据DescribeMetricsForCreateAlarm接口查询各产品线可用的监控项(创建规则时使用Metric字段)。格式:metric:downsample
- metricId – (Optional) 监控项ID
- noticeLevel – (Optional)
- noticePeriod – 通知周期,单位:小时
- operation – 报警比较符,只能为以下几种lte(<=),lt(<),gt(>),gte(>=),eq(==),ne(!=)
- period – 查询指标的周期,单位为分钟,目前支持的取值:1, 2,5,10,15,30,60
- ruleType – 规则类型, 1表示云监控,2表示弹性伸缩,3表示AG,4表示AutoHeal,5表示自定义监控,6表示hawkeye
- tags – (Optional) 多值标签
- threshold – 报警阈值,目前只开放数值类型功能
- times – 连续探测几次都满足阈值条件时报警,可选值:1,2,3,5,10,15,30,60
jdcloud_sdk.services.monitor.models.BatchCreateAlarmsSpec module¶
jdcloud_sdk.services.monitor.models.BatchSwitchAlarmsSpec module¶
jdcloud_sdk.services.monitor.models.BatchUpdateWidgetError module¶
jdcloud_sdk.services.monitor.models.BatchUpdateWidgetOut module¶
jdcloud_sdk.services.monitor.models.BatchUpdateWidgetSpec module¶
jdcloud_sdk.services.monitor.models.Chart module¶
-
class
jdcloud_sdk.services.monitor.models.Chart.Chart(id=None, serviceCode=None, groupCode=None, chartNameCH=None, chartNameEN=None, chartUnitCH=None, chartUnitEN=None, chartIndex=None, metrics=None, metricIds=None, column=None, dir=None, number=None, size=None)[source]¶ Bases:
objectParameters: - id – (Optional) 自增id
- serviceCode – (Optional) serviceCode
- groupCode – (Optional) groupCode
- chartNameCH – (Optional) chartNameCH
- chartNameEN – (Optional) chartNameEN
- chartUnitCH – (Optional) chartUnitCH
- chartUnitEN – (Optional) chartUnitEN
- chartIndex – (Optional) chartIndex
- metrics – (Optional) metrics
- metricIds – (Optional) metricIds
- column – (Optional) 排序字段
- dir – (Optional) 排序方式
- number – (Optional) 页码
- size – (Optional) 查询条数
jdcloud_sdk.services.monitor.models.CmAlarm module¶
-
class
jdcloud_sdk.services.monitor.models.CmAlarm.CmAlarm(calculation=None, contactGroups=None, contactPersons=None, createTime=None, enabled=None, id=None, metric=None, metricName=None, namespace=None, namespaceUID=None, noticePeriod=None, noticeTime=None, obj=None, objUID=None, operation=None, period=None, region=None, resourceId=None, rootRuleId=None, ruleId=None, ruleName=None, serviceCode=None, status=None, tag=None, threshold=None, times=None, value=None)[source]¶ Bases:
objectParameters: - calculation – (Optional) 统计方法:平均值=avg、最大值=max、最小值=min
- contactGroups – (Optional)
- contactPersons – (Optional)
- createTime – (Optional)
- enabled – (Optional) 启用禁用 1启用,0禁用
- id – (Optional) 规则id
- metric – (Optional) 监控项
- metricName – (Optional) 规则id监控项名称
- namespace – (Optional) 命名空间
- namespaceUID – (Optional) 命名空间id
- noticePeriod – (Optional) 通知周期 单位:小时
- noticeTime – (Optional)
- obj – (Optional) 对象
- objUID – (Optional) 对象id
- operation – (Optional) >=、>、<、<=、=、!=
- period – (Optional) 统计周期(单位:分钟)
- region – (Optional) 地域信息
- resourceId – (Optional) 此规则所应用的资源id
- rootRuleId – (Optional) root rule id
- ruleId – (Optional) rule id
- ruleName – (Optional) 规则名称
- serviceCode – (Optional) 报警规则对应的产品
- status – (Optional) 监控项状态:1正常,2告警,4数据不足
- tag – (Optional) 监控项附属信息
- threshold – (Optional) 阈值
- times – (Optional) 连续多少次后报警
- value – (Optional) 报警值
jdcloud_sdk.services.monitor.models.CmAlarmHistory module¶
-
class
jdcloud_sdk.services.monitor.models.CmAlarmHistory.CmAlarmHistory(calculation=None, contactGroups=None, contactPersons=None, deleted=None, enabled=None, id=None, metric=None, metricName=None, namespace=None, namespaceUID=None, noticePeriod=None, noticeTime=None, obj=None, objUID=None, operation=None, period=None, region=None, resourceId=None, rootRuleId=None, ruleId=None, ruleName=None, serviceCode=None, tag=None, threshold=None, times=None, value=None)[source]¶ Bases:
objectParameters: - calculation – (Optional) 统计方法:平均值=avg、最大值=max、最小值=min
- contactGroups – (Optional)
- contactPersons – (Optional)
- deleted – (Optional) 该规则是否已经被删除,1表示已经被删除,0表示未删除,被删除的规则,在使用查询规则的接口时,将不会被检索到
- enabled – (Optional) 启用禁用 1启用,0禁用
- id – (Optional) 规则id
- metric – (Optional) 监控项
- metricName – (Optional) 规则id监控项名称
- namespace – (Optional) 命名空间
- namespaceUID – (Optional) 命名空间id
- noticePeriod – (Optional) 通知周期 单位:小时
- noticeTime – (Optional)
- obj – (Optional) 对象
- objUID – (Optional) 对象id
- operation – (Optional) >=、>、<、<=、=、!=
- period – (Optional) 统计周期(单位:分钟)
- region – (Optional) 地域信息
- resourceId – (Optional) 此规则所应用的资源id
- rootRuleId – (Optional) root rule id
- ruleId – (Optional) rule id
- ruleName – (Optional) 规则名称
- serviceCode – (Optional) 报警规则对应的产品
- tag – (Optional) 监控项附属信息
- threshold – (Optional) 阈值
- times – (Optional) 连续多少次后报警
- value – (Optional) 报警值
jdcloud_sdk.services.monitor.models.CreateAlarmParam module¶
jdcloud_sdk.services.monitor.models.CreateAlarmSpec module¶
-
class
jdcloud_sdk.services.monitor.models.CreateAlarmSpec.CreateAlarmSpec(clientToken, product, resourceOption, ruleName, ruleOption, autoScalingPolicyId=None, baseContact=None, dataOwner=None, dimension=None, enabled=None, multiWebHook=None, noticeOption=None, ruleType=None, tags=None, webHookOption=None)[source]¶ Bases:
objectParameters: - autoScalingPolicyId – (Optional) 弹性伸缩组Id。注:仅agsg产品线内部使用
- baseContact – (Optional) 告警通知联系人
- clientToken – 幂等性校验参数,最长36位,若两个请求clientToken相等,则返回第一次创建的规则id,只创建一次规则
- dataOwner – (Optional) 数据所有者,1云监控控制台; 2云鼎。默认为1
- dimension – (Optional) 资源维度,可用的维度请使用 describeProductsForAlarm接口查询
- enabled – (Optional) 是否启用, 1表示启用规则,0表示禁用规则,默认为1
- multiWebHook – (Optional) url回调设置数组
- noticeOption – (Optional) 通知策略
- product – 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。
- resourceOption –
- ruleName – 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、’’-‘’和”_”
- ruleOption –
- ruleType – (Optional) 规则类型, 默认为resourceMonitor
- tags – (Optional) 资源维度,指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签,否则规则会报数据不足)
- webHookOption – (Optional)
jdcloud_sdk.services.monitor.models.CreateCmAlarmParam module¶
-
class
jdcloud_sdk.services.monitor.models.CreateCmAlarmParam.CreateCmAlarmParam(calculation, metricUID, namespaceUID, objUIDs, operation, period, threshold, times, contactGroups=None, contactPersons=None, downSample=None, noticePeriod=None, ruleName=None)[source]¶ Bases:
objectParameters: - calculation – 统计方法,必须与定义的metric一致,可选值列表:avg,max,sum,min
- contactGroups – (Optional) 报警规则通知的联系组,必须在控制台上已创建,例如” [‘联系组1’,’联系组2’]”
- contactPersons – (Optional) 报警规则通知的联系人,必须在控制台上已创建,例如 [“联系人1”,”联系人2”]
- downSample – (Optional) 取样频次
- metricUID – 根据产品线查询可用监控项列表 接口 返回的Metric字段
- namespaceUID – 命名空间
- noticePeriod – (Optional) 通知周期 单位:小时
- objUIDs – 报警规则对应实例列表,每次最多100个,例如”[‘resourceId1’,’resourceId2’]”
- operation – 报警比较符,只能为以下几种<=,<,>,>=,==,!=
- period – 查询指标的周期,单位为分钟,目前支持的取值:2,5,15,30,60
- ruleName – (Optional) 规则名称,最大长度42个字符,只允许中英文、数字、’’-‘’和”_”
- threshold – 报警阈值,目前只开放数值类型功能
- times – 连续探测几次都满足阈值条件时报警,可选值:1,2,3,5
jdcloud_sdk.services.monitor.models.CreateCmAlarmSpec module¶
jdcloud_sdk.services.monitor.models.CreateDashboardSpec module¶
jdcloud_sdk.services.monitor.models.CreateProbeTaskParam module¶
jdcloud_sdk.services.monitor.models.CreateProbeTaskSpec module¶
jdcloud_sdk.services.monitor.models.CreateSiteMonitorSpec module¶
jdcloud_sdk.services.monitor.models.CreateTemplateSpec module¶
-
class
jdcloud_sdk.services.monitor.models.CreateTemplateSpec.CreateTemplateSpec(clientToken, ruleServiceCode, serviceCode, templateName, templateRules, description=None)[source]¶ Bases:
objectParameters: - clientToken – 幂等性校验参数,最长36位
- description – (Optional) 模板描述
- ruleServiceCode – 规则的资源类型
- serviceCode – 模板的资源类型
- templateName – 模板名称,长度1-32个字符,只允许中英文、数字、’’-‘’和”_”
- templateRules – 模板内包含的规则
jdcloud_sdk.services.monitor.models.CreateWidgetSpec module¶
-
class
jdcloud_sdk.services.monitor.models.CreateWidgetSpec.CreateWidgetSpec(aggregated=None, createdTime=None, dashboardId=None, metrics=None, name=None, position=None, resources=None, serviceCode=None, topN=None, type=None, updatedTime=None, widgetId=None)[source]¶ Bases:
objectParameters: - aggregated – (Optional)
- createdTime – (Optional)
- dashboardId – (Optional)
- metrics – (Optional)
- name – (Optional)
- position – (Optional)
- resources – (Optional)
- serviceCode – (Optional)
- topN – (Optional)
- type – (Optional)
- updatedTime – (Optional)
- widgetId – (Optional)
jdcloud_sdk.services.monitor.models.Dashboard module¶
-
class
jdcloud_sdk.services.monitor.models.Dashboard.Dashboard(createdTime=None, dashboardId=None, focused=None, name=None, pin=None, updatedTime=None, widgetCount=None)[source]¶ Bases:
objectParameters: - createdTime – (Optional)
- dashboardId – (Optional)
- focused – (Optional)
- name – (Optional)
- pin – (Optional)
- updatedTime – (Optional)
- widgetCount – (Optional)
jdcloud_sdk.services.monitor.models.DataPoint module¶
jdcloud_sdk.services.monitor.models.DataPointX module¶
-
class
jdcloud_sdk.services.monitor.models.DataPointX.DataPointX(metric, timestamp, value, tags=None)[source]¶ Bases:
objectParameters: - metric – 监控指标名称,长度不超过255字节,只允许英文、数字、下划线_、点., [0-9][a-z] [A-Z] [. _ ], 其它会返回err
- tags – (Optional) 数据维度,数据类型为map类型,最多五个标签,尽量不传或少传。总长度不大于255字节,只允许英文、数字、下划线_、点., [0-9][a-z] [A-Z] [. _ ], 其它会返回err
- timestamp – 秒级时间戳,早于当前时间30天的不能写入;建议的上报时间戳:上报时间间隔的整数倍,如上报间隔为5s,则建议上报的时间戳为 timestamp = current timestamp - (current timestamp % time interval) = 1487647187 - (1487647187 % 5) = 1487647187 -2 = 1487647185
- value – 监控的值。number or string。最大值为long.MAX_VALUE=9223372036854775807=263-1。累计类型的指标,累计到最大值后需要翻转为0,重新开始计数。翻转后不影响速率的计算。
jdcloud_sdk.services.monitor.models.DataTag module¶
-
class
jdcloud_sdk.services.monitor.models.DataTag.DataTag(operation=None, tagKey=None, tagValue=None)[source]¶ Bases:
objectparam operation: (Optional) 1 进数据点打tag,如果数据点存在该tag,予以覆盖,2进行数据点打tag,如果数据存在该tag,跳过不予处理,3 对于数据点中存在tag进行改名称, - 例如:{“tagKey”:”resourceId”,”tagValue”:”nodeId”,”operation”:3},原数据点名称resourceId:”ia-adx01”改名成nodeId:”ia-adx01”
param tagKey: (Optional) param tagValue: (Optional)
jdcloud_sdk.services.monitor.models.DescribeAlarmingRulesEnd module¶
jdcloud_sdk.services.monitor.models.DescribeCMMetricsDataSpec module¶
-
class
jdcloud_sdk.services.monitor.models.DescribeCMMetricsDataSpec.DescribeCMMetricsDataSpec(aggrType=None, endTime=None, metricUID=None, startTime=None, timeInterval=None)[source]¶ Bases:
objectparam aggrType: (Optional) param endTime: (Optional) 查询时间范围的结束时间, UTC时间,格式:2016-12-11T00:00:00+0800(为空时,将由startTime与timeInterval计算得出)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) - in: query
param metricUID: (Optional) metric id列表 - in: query
param startTime: (Optional) 查询时间范围的开始时间, UTC时间,格式:2016-12-11T00:00:00+0800(早于30d时,将被重置为30d)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) - in: query
param timeInterval: (Optional) 时间间隔:1h,6h,12h,1d,3d,7d,14d,固定时间间隔,timeInterval 与 endTime 至少填一项
in: query
jdcloud_sdk.services.monitor.models.DescribeCmMetricDataByTagSpec module¶
jdcloud_sdk.services.monitor.models.DescribeMetricDataSpec module¶
-
class
jdcloud_sdk.services.monitor.models.DescribeMetricDataSpec.DescribeMetricDataSpec(resourceId, aggrType=None, dimension=None, downSampleType=None, endTime=None, groupBy=None, rate=None, serviceCode=None, startTime=None, tags=None, timeInterval=None)[source]¶ Bases:
objectparam aggrType: (Optional) 聚合方式,可选值参考:sum、avg、min、max param dimension: (Optional) 资源的维度。当serviceCode下存在多个维度时,查询数据必须指定相应的维度 param downSampleType: (Optional) 采样方式,可选值参考:sum、avg、last、min、max param endTime: (Optional) 查询时间范围的结束时间, UTC时间,格式:2016-12-11T00:00:00+0800(为空时,将由startTime与timeInterval计算得出)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) - in: query
param groupBy: (Optional) 是否对查询的tags分组 - in: query
param rate: (Optional) 是否求速率 - in: query
param resourceId: 资源的uuid param serviceCode: (Optional) 资源的类型,取值vm, lb, ip, database 等,<a href=”https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud”>describeServices</a>:查询己接入云监控的产品线列表,当产品线下有多个分组时,查询分组对应的监控项,serviceCode请传对应分组的groupCode字段值 param startTime: (Optional) 查询时间范围的开始时间, UTC时间,格式:2016-12-11T00:00:00+0800(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) - in: query
param tags: (Optional) 监控指标数据的维度信息,根据tags来筛选指标数据不同的维度 - in: query
param timeInterval: (Optional) 时间间隔:1h,6h,12h,1d,3d,7d,14d,固定时间间隔,timeInterval默认为1h,当前时间往 前1h
in: query
jdcloud_sdk.services.monitor.models.DescribeRuleCountingEnd module¶
jdcloud_sdk.services.monitor.models.DescribeSqlserverBlockProcessOut module¶
jdcloud_sdk.services.monitor.models.DescribeTemplateByIDSpec module¶
jdcloud_sdk.services.monitor.models.DescribeTopNSlowSqlSpec module¶
-
class
jdcloud_sdk.services.monitor.models.DescribeTopNSlowSqlSpec.DescribeTopNSlowSqlSpec(resourceId, serviceCode, topN, endTime=None, startTime=None, timeInterval=None)[source]¶ Bases:
objectparam endTime: (Optional) 查询时间范围的结束时间, UTC时间,格式:2016-12-11T00:00:00+0800(为空时,将由startTime与timeInterval计算得出)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) - in: query
param resourceId: 资源的uuid param serviceCode: 资源的类型,sqlserver param startTime: (Optional) 查询时间范围的开始时间, UTC时间,格式:2016-12-11T00:00:00+0800(早于30d时,将被重置为30d)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) - in: query
param timeInterval: (Optional) 时间间隔:1h,6h,12h,1d,3d,7d,14d,固定时间间隔,timeInterval 与 endTime 至少填一项 - in: query
param topN: topN数量
jdcloud_sdk.services.monitor.models.DescribedAlarm module¶
-
class
jdcloud_sdk.services.monitor.models.DescribedAlarm.DescribedAlarm(calculateUnit=None, calculation=None, createTime=None, downSample=None, enabled=None, id=None, metric=None, metricName=None, noticeLevel=None, noticePeriod=None, operation=None, period=None, region=None, resourceId=None, ruleName=None, serviceCode=None, status=None, tags=None, threshold=None, times=None, webHookContent=None, webHookProtocol=None, webHookSecret=None, webHookUrl=None)[source]¶ Bases:
objectParameters: - calculateUnit – (Optional) 计算单位
- calculation – (Optional) 统计方法:平均值=avg、最大值=max、最小值=min
- createTime – (Optional) 创建时间
- downSample – (Optional) 降采样方法
- enabled – (Optional) 是否启用
- id – (Optional) 报警规则ID
- metric – (Optional) 监控项
- metricName – (Optional) 监控项名称
- noticeLevel – (Optional)
- noticePeriod – (Optional) 告警周期
- operation – (Optional) gt, gte, lt, lte, eq, ne
- period – (Optional) 统计周期(单位:分钟)
- region – (Optional) 地域信息
- resourceId – (Optional) 资源id
- ruleName – (Optional) 规则名称
- serviceCode – (Optional) 产品线编码
- status – (Optional) 监控项状态:1正常,2告警,4数据不足
- tags – (Optional) 标签
- threshold – (Optional) 告警阈值
- times – (Optional) 告警次数
- webHookContent – (Optional) 回调content
- webHookProtocol – (Optional) webHook协议
- webHookSecret – (Optional) 回调secret,用户请求签名,防伪造
- webHookUrl – (Optional) 回调url
jdcloud_sdk.services.monitor.models.DescribedAlarmHistory module¶
-
class
jdcloud_sdk.services.monitor.models.DescribedAlarmHistory.DescribedAlarmHistory(alarmId=None, dimension=None, dimensionName=None, durationTimes=None, isOneClickAlarm=None, noticeDurationTime=None, noticeLevel=None, noticeLevelTriggered=None, noticeTime=None, noticeTimeUnix=None, product=None, productName=None, receivers=None, region=None, resourceId=None, rule=None, ruleType=None, status=None, tags=None, value=None)[source]¶ Bases:
objectParameters: - alarmId – (Optional) 报警规则ID
- dimension – (Optional) 资源维度
- dimensionName – (Optional) 资源维度名称
- durationTimes – (Optional) 告警持续次数
- isOneClickAlarm – (Optional) 是否是一键告警 (1-一键告警 0-非一键告警)
- noticeDurationTime – (Optional) 告警持续时间,单位分钟
- noticeLevel – (Optional) 用于前端显示的‘触发告警级别’。从低到高分别为‘普通’, ‘紧急’, ‘严重’
- noticeLevelTriggered – (Optional) 触发的告警级别。从低到高分别为‘common’, ‘critical’, ‘fatal’
- noticeTime – (Optional) 告警时间
- noticeTimeUnix – (Optional) 告警时间对应的时间戳
- product – (Optional) 资源类型
- productName – (Optional) 资源类型名称
- receivers – (Optional) 告警通知人
- region – (Optional) 资源Id对应的region
- resourceId – (Optional) 资源Id
- rule – (Optional)
- ruleType – (Optional) 规则类型
- status – (Optional) 告警类型 1-告警恢复 2-告警 4-数据不足
- tags – (Optional) 资源tags
- value – (Optional) 告警值
jdcloud_sdk.services.monitor.models.DescribedNoticeContacts module¶
jdcloud_sdk.services.monitor.models.EnableSiteMonitorReqItem module¶
jdcloud_sdk.services.monitor.models.EnableSiteMonitorSpec module¶
jdcloud_sdk.services.monitor.models.Err module¶
jdcloud_sdk.services.monitor.models.ErrorBody module¶
jdcloud_sdk.services.monitor.models.Event module¶
jdcloud_sdk.services.monitor.models.Filter module¶
jdcloud_sdk.services.monitor.models.GetWidgetDataPointsSpec module¶
-
class
jdcloud_sdk.services.monitor.models.GetWidgetDataPointsSpec.GetWidgetDataPointsSpec(aggregated=None, createdTime=None, dashboardId=None, endTime=None, filters=None, metrics=None, name=None, position=None, resources=None, serviceCode=None, startTime=None, topN=None, type=None, updatedTime=None, widgetId=None)[source]¶ Bases:
objectParameters: - aggregated – (Optional)
- createdTime – (Optional)
- dashboardId – (Optional)
- endTime – (Optional)
- filters – (Optional) name为widgetId - 多个图表的id
- metrics – (Optional)
- name – (Optional)
- position – (Optional)
- resources – (Optional)
- serviceCode – (Optional)
- startTime – (Optional)
- topN – (Optional)
- type – (Optional)
- updatedTime – (Optional)
- widgetId – (Optional)
jdcloud_sdk.services.monitor.models.GetWidgetMetricOut module¶
jdcloud_sdk.services.monitor.models.GroupInfo module¶
-
class
jdcloud_sdk.services.monitor.models.GroupInfo.GroupInfo(charts=None, groupCode=None, groupName=None, tags=None, webCode=None)[source]¶ Bases:
objectParameters: - charts – (Optional) 监控图的展示方式
- groupCode – (Optional) 分组groupCode
- groupName – (Optional) 分组名称
- tags – (Optional) 分组下metric对应的tags
- webCode – (Optional) 分组的webCode
jdcloud_sdk.services.monitor.models.HandleTag module¶
jdcloud_sdk.services.monitor.models.HandleTags module¶
jdcloud_sdk.services.monitor.models.IspLocation module¶
jdcloud_sdk.services.monitor.models.KeyValue module¶
jdcloud_sdk.services.monitor.models.LastDownsampleRespItem module¶
jdcloud_sdk.services.monitor.models.Location module¶
jdcloud_sdk.services.monitor.models.MaintainAuxiliaryTags module¶
-
class
jdcloud_sdk.services.monitor.models.MaintainAuxiliaryTags.MaintainAuxiliaryTags(appCode, groupCode, resourceIds, serviceCode, srcServiceCode, tags, filter=None)[source]¶ Bases:
objectParameters: - appCode – 应用码。调用此API前需找云监控提供
- filter – (Optional) 详细的过滤条件。
- groupCode – 组id。须确保在一个APP范围内全局唯一
- resourceIds – 资源列表。
- serviceCode – 资源的产品线,要对哪个产品线的资源打标签
- srcServiceCode – 打标签操作所属产品线的serviceCode
- tags –
jdcloud_sdk.services.monitor.models.Metric module¶
-
class
jdcloud_sdk.services.monitor.models.Metric.Metric(id=None, serviceCode=None, metricIndex=None, metricID=None, metricNameCH=None, metricNameEN=None, valueType=None, downsampleAgg=None, groupAgg=None, isRate=None, isSumRate=None, defaultDownsample=None, upUnit=None, monitorUnitCH=None, monitorUnitEN=None, alarmUnitCH=None, alarmUnitEN=None, unitConvertFrom=None, unitConvertTo=None, isShow=None, isEnable=None, defaultTagName=None, defaultTagValue=None, tags=None, isAlarm=None, newNet=None, timeInterval=None, serviceCodes=None, groupIds=None, groupCodes=None, column=None, dir=None, number=None, size=None)[source]¶ Bases:
objectParameters: - id – (Optional) 自增id
- serviceCode – (Optional) serviceCode
- metricIndex – (Optional) metricIndex
- metricID – (Optional) metricID
- metricNameCH – (Optional) metricNameCH
- metricNameEN – (Optional) metricNameEN
- valueType – (Optional) valueType
- downsampleAgg – (Optional) downsampleAgg
- groupAgg – (Optional) groupAgg
- isRate – (Optional) isRate
- isSumRate – (Optional) isSumRate
- defaultDownsample – (Optional) defaultDownsample
- upUnit – (Optional) upUnit
- monitorUnitCH – (Optional) monitorUnitCH
- monitorUnitEN – (Optional) monitorUnitEN
- alarmUnitCH – (Optional) alarmUnitCH
- alarmUnitEN – (Optional) alarmUnitEN
- unitConvertFrom – (Optional) unitConvertFrom
- unitConvertTo – (Optional) unitConvertTo
- isShow – (Optional) isShow
- isEnable – (Optional) isEnable
- defaultTagName – (Optional) defaultTagName
- defaultTagValue – (Optional) defaultTagValue
- tags – (Optional) tags
- isAlarm – (Optional) isAlarm
- newNet – (Optional) newNet
- timeInterval – (Optional) timeInterval
- serviceCodes – (Optional) 业务线代码
- groupIds – (Optional) 分组id
- groupCodes – (Optional) 分组信息
- column – (Optional) 排序字段
- dir – (Optional) 排序方式
- number – (Optional) 页码
- size – (Optional) 查询条数
jdcloud_sdk.services.monitor.models.MetricCm module¶
-
class
jdcloud_sdk.services.monitor.models.MetricCm.MetricCm(aggrType=None, calculateUnit=None, dimensions=None, downSamplePeriod=None, downSampleType=None, metric=None, metricName=None)[source]¶ Bases:
objectParameters: - aggrType – (Optional)
- calculateUnit – (Optional)
- dimensions – (Optional)
- downSamplePeriod – (Optional)
- downSampleType – (Optional)
- metric – (Optional)
- metricName – (Optional)
jdcloud_sdk.services.monitor.models.MetricData module¶
jdcloud_sdk.services.monitor.models.MetricDataCm module¶
-
class
jdcloud_sdk.services.monitor.models.MetricDataCm.MetricDataCm(namespace, metric, dimensions, timestamp, type, values, unit=None)[source]¶ Bases:
objectParameters: - namespace – 命名空间 ,长度不超过255字节,只允许英文、数字、下划线_、点., [0-9][a-z] [A-Z] [. _ ], 其它会返回err
- metric – 监控指标名称,长度不超过255字节,只允许英文、数字、下划线_、点., [0-9][a-z] [A-Z] [. _ ], 其它会返回err
- dimensions – 数据维度,数据类型为map类型,支持最少一个,最多6个标签,总长度不大于1024字节,只允许英文、数字、下划线_、点., [0-9][a-z] [A-Z] [. _ ], 其它会返回err。eg:{“host”:”127.0.0.1”,”region”:”cn-north-1”,”role”:”M”}
- timestamp – 上报数据点的时间戳,只支持10位,秒级时间戳,不能写入过去30天的时间
- type – 数据上报类型,1为原始值
- values – 指标值集合,数据类型必须为map类型,key为数据类型,value为数据值,当type=1时,key只能为”value”,上报的是原始值,value内容为整型或浮点型数字,最大值为9223372036854775807
- unit – (Optional) 数据的单位,长度不超过64字节,只允许英文、数字、下划线_、点., [0-9][a-z] [A-Z] [. _ ], 其它会返回err
jdcloud_sdk.services.monitor.models.MetricDataItemCm module¶
jdcloud_sdk.services.monitor.models.MetricDataList module¶
jdcloud_sdk.services.monitor.models.MetricDataRespToFE module¶
jdcloud_sdk.services.monitor.models.MetricDetail module¶
-
class
jdcloud_sdk.services.monitor.models.MetricDetail.MetricDetail(calculateUnit=None, dimension=None, downSample=None, metric=None, metricName=None, serviceCode=None)[source]¶ Bases:
objectParameters: - calculateUnit – (Optional) 指标的计算单位,比如bit/s、%、k等
- dimension – (Optional) 维度标识
- downSample – (Optional) 取样频次
- metric – (Optional) 监控项英文标识
- metricName – (Optional) 监控项名称
- serviceCode – (Optional) 产品线标识
jdcloud_sdk.services.monitor.models.MetricInfo module¶
jdcloud_sdk.services.monitor.models.NoticeLevel module¶
-
class
jdcloud_sdk.services.monitor.models.NoticeLevel.NoticeLevel(custom, levels)[source]¶ Bases:
objectParameters: - custom – 是否为用户自己定义的级别,自定义(true) or 固定(false)
- levels – 报警级别以及对应的阈值,是一个map[string]float64对象。key:common(一般)、critical(严重)、 fatal(紧急),value:各报警级别对应的阀值,要符合operation参数对应的递进关系。 eg: “levels”:{“common”:1000,”critical”:10000,”fatal”:15000}
jdcloud_sdk.services.monitor.models.NsInfo module¶
jdcloud_sdk.services.monitor.models.ObjInfo module¶
jdcloud_sdk.services.monitor.models.Probe module¶
jdcloud_sdk.services.monitor.models.ProbeInfo module¶
jdcloud_sdk.services.monitor.models.ProbeTaskEnableSpec module¶
jdcloud_sdk.services.monitor.models.PutBody module¶
-
class
jdcloud_sdk.services.monitor.models.PutBody.PutBody(appCode, serviceCode, region, resourceId, dataPoints)[source]¶ Bases:
objectParameters: - appCode – 目前统一用jcloud
- serviceCode – 资源的类型,取值vm,ip,database,storage,disk,cdn,redis,balance,nat_gw,db_ro,vpn,ddos等,新接入的产品要求与opentapi命名的产品线名称一致
- region – 地域信息,如 cn-north-1 等
- resourceId – 资源的唯一表示,一般为uuid
- dataPoints – 监控数据点
jdcloud_sdk.services.monitor.models.Resource module¶
jdcloud_sdk.services.monitor.models.Rule module¶
jdcloud_sdk.services.monitor.models.RuleCounting module¶
-
class
jdcloud_sdk.services.monitor.models.RuleCounting.RuleCounting(alarmRuleCount=None, disableRuleCount=None, normalRuleCount=None, product=None, totalRuleCount=None, unknownRuleCount=None)[source]¶ Bases:
objectParameters: - alarmRuleCount – (Optional) 处于报警状态的规则个数 status:2
- disableRuleCount – (Optional) 未启用的规则 数量
- normalRuleCount – (Optional) 处于正常状态的规则个数 status:1
- product – (Optional) 产品标识
- totalRuleCount – (Optional) 监控规则 总数
- unknownRuleCount – (Optional) 处于数据不足状态的规则 个数 status:4
jdcloud_sdk.services.monitor.models.RuleState module¶
jdcloud_sdk.services.monitor.models.ServiceCodeMetrics module¶
jdcloud_sdk.services.monitor.models.ServiceInfo module¶
-
class
jdcloud_sdk.services.monitor.models.ServiceInfo.ServiceInfo(groupTree=None, metricGroup=None, metricsTimeDelay=None, serviceCode=None, serviceName=None, timeInterval=None)[source]¶ Bases:
objectParameters: - groupTree – (Optional)
- metricGroup – (Optional) 产品线下的分组信息
- metricsTimeDelay – (Optional) 上报延迟
- serviceCode – (Optional) 产品线ServiceCode
- serviceName – (Optional) 产品线名称
- timeInterval – (Optional) 上报的时间间隔
jdcloud_sdk.services.monitor.models.ServiceMetric module¶
jdcloud_sdk.services.monitor.models.ServiceMetricAggregateItem module¶
jdcloud_sdk.services.monitor.models.ServiceMetricItem module¶
-
class
jdcloud_sdk.services.monitor.models.ServiceMetricItem.ServiceMetricItem(aggregates=None, calculateUnit=None, metric=None, name=None, serviceCode=None)[source]¶ Bases:
objectParameters: - aggregates – (Optional)
- calculateUnit – (Optional)
- metric – (Optional)
- name – (Optional)
- serviceCode – (Optional)
jdcloud_sdk.services.monitor.models.SiteMonitor module¶
jdcloud_sdk.services.monitor.models.SiteMonitorEnableReqItem module¶
jdcloud_sdk.services.monitor.models.SiteMonitorHttpOption module¶
jdcloud_sdk.services.monitor.models.SiteMonitorSource module¶
jdcloud_sdk.services.monitor.models.SiteMonitorTcpOption module¶
jdcloud_sdk.services.monitor.models.SiteMonitorUdpOption module¶
jdcloud_sdk.services.monitor.models.SqlDataPoint module¶
-
class
jdcloud_sdk.services.monitor.models.SqlDataPoint.SqlDataPoint(appCode, serviceCode, region, resourceId, metric, time, value, start_time, execution_time, session_id, database, client_net_address, loginname, status, sqlstr)[source]¶ Bases:
objectParameters: - appCode – 目前统一用jcloud
- serviceCode – 资源的类型,取值sqlserver
- region – 资源所在的地域
- resourceId – 资源的uuid
- metric – 监控指标名称,长度不超过255字节,只允许英文、数字、下划线_、点., [0-9][a-z] [A-Z] [. _ ], 其它会返回err
- time – 毫秒级时间戳,早于当前时间30天的不能写入;建议的上报时间戳:上报时间间隔的整数倍,如上报间隔为5ms,则建议上报的时间戳为 time = current timestamp - (current timestamp % time interval) = 1487647187007 - (1487647187007 % 5) = 1487647187007 -2 = 1487647187005
- value – 上报的监控值,即慢sql语句已经执行的时间(单位s)
- start_time – SQL开始执行的时间
- execution_time – SQL已执行时间(单位s)
- session_id – 会话ID
- database – 数据库库名
- client_net_address – 客户端IP地址
- loginname – 用户名
- status – SQL会话请求状态
- sqlstr – SQL详细文本
jdcloud_sdk.services.monitor.models.SqlInfo module¶
-
class
jdcloud_sdk.services.monitor.models.SqlInfo.SqlInfo(appCode=None, client_net_address=None, database=None, execution_time=None, loginname=None, metric=None, region=None, resourceId=None, serviceCode=None, session_id=None, sqlstr=None, start_time=None, status=None, time=None, value=None)[source]¶ Bases:
objectParameters: - appCode – (Optional) 产品标识,目前统一用jcloud
- client_net_address – (Optional) 客户端IP地址
- database – (Optional) 库名
- execution_time – (Optional) SQL已执行时间(单位s)
- loginname – (Optional) 用户名
- metric – (Optional) 监控项
- region – (Optional) 资源所在的地域
- resourceId – (Optional) 资源的uuid
- serviceCode – (Optional) 资源的类型
- session_id – (Optional) 会话ID
- sqlstr – (Optional) SQL详细文本
- start_time – (Optional) SQL开始执行的时间
- status – (Optional) SQL会话请求状态
- time – (Optional) 毫秒级时间戳
- value – (Optional) 上报的监控值
jdcloud_sdk.services.monitor.models.StatisticsProductMetric module¶
-
class
jdcloud_sdk.services.monitor.models.StatisticsProductMetric.StatisticsProductMetric(aggregate=None, calculateUnit=None, metric=None, metricShow=None)[source]¶ Bases:
objectParameters: - aggregate – (Optional) 聚合方式
- calculateUnit – (Optional) 单位
- metric – (Optional) metric
- metricShow – (Optional) metric名称
jdcloud_sdk.services.monitor.models.StatsItem module¶
-
class
jdcloud_sdk.services.monitor.models.StatsItem.StatsItem(aggregateFunc=None, calculateUnit=None, dps=None, metric=None, metricName=None, tags=None)[source]¶ Bases:
objectParameters: - aggregateFunc – (Optional) 聚合方式
- calculateUnit – (Optional) 单位
- dps – (Optional) 数据点
- metric – (Optional) metric
- metricName – (Optional) metric名称
- tags – (Optional) tags
jdcloud_sdk.services.monitor.models.Tag module¶
jdcloud_sdk.services.monitor.models.TagFilter module¶
jdcloud_sdk.services.monitor.models.TagKeyValue module¶
jdcloud_sdk.services.monitor.models.TagsSpec module¶
jdcloud_sdk.services.monitor.models.TaskInfo module¶
jdcloud_sdk.services.monitor.models.TemplateVo module¶
-
class
jdcloud_sdk.services.monitor.models.TemplateVo.TemplateVo(createTime=None, description=None, pin=None, rulesCount=None, serviceCode=None, templateId=None, templateName=None, templateRules=None, templateRulesString=None, templateType=None, updateTime=None)[source]¶ Bases:
objectParameters: - createTime – (Optional)
- description – (Optional) 模板描述
- pin – (Optional) 用户
- rulesCount – (Optional) 模板内包含的规则数量
- serviceCode – (Optional) 模板所属资源类型
- templateId – (Optional) 模板id
- templateName – (Optional) 模板名称
- templateRules – (Optional) 模板内包含的规则
- templateRulesString – (Optional) 模板内包含的提供给前端的拼接好的规则
- templateType – (Optional) 模板类型,区分默认模板和用户自定义模板:1表示默认模板,2表示用户自定义模板
- updateTime – (Optional)
jdcloud_sdk.services.monitor.models.UpdateAlarmResponseEnd module¶
jdcloud_sdk.services.monitor.models.UpdateAlarmSpec module¶
-
class
jdcloud_sdk.services.monitor.models.UpdateAlarmSpec.UpdateAlarmSpec(product, resourceOption, ruleName, ruleOption, autoScalingPolicyId=None, baseContact=None, dataOwner=None, dimension=None, enabled=None, multiWebHook=None, noticeOption=None, ruleType=None, tags=None, webHookOption=None)[source]¶ Bases:
objectParameters: - autoScalingPolicyId – (Optional) 弹性伸缩组Id。注:仅agsg产品线内部使用
- baseContact – (Optional) 告警通知联系人
- dataOwner – (Optional) 数据所有者,1云监控控制台; 2云鼎。默认为1
- dimension – (Optional) 资源维度,可用的维度请使用 describeProductsForAlarm接口查询
- enabled – (Optional) 是否启用, 1表示启用规则,0表示禁用规则,默认为1
- multiWebHook – (Optional) url回调设置数组
- noticeOption – (Optional) 通知策略
- product – 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。
- resourceOption –
- ruleName – 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、’’-‘’和”_”
- ruleOption –
- ruleType – (Optional) 规则类型, 默认为resourceMonitor
- tags – (Optional) 资源维度,指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签,否则规则会报数据不足)
- webHookOption – (Optional)
jdcloud_sdk.services.monitor.models.UpdateCmAlarmSpec module¶
-
class
jdcloud_sdk.services.monitor.models.UpdateCmAlarmSpec.UpdateCmAlarmSpec(aggrType, dimensions, namespace, region, ruleName, ruleOption, baseContact=None, dataOwner=None, enabled=None, multiWebHook=None, noticeOption=None, webHookOption=None)[source]¶ Bases:
objectparam aggrType: 聚合方式,多个维度聚合成1个维度时,多维度值之间的聚合方式。可选值:sum、avg、min、max param baseContact: (Optional) 告警通知联系人 param dataOwner: (Optional) 数据所有者,1云监控控制台; 2云鼎。默认为1 - in: query
param dimensions: 资源维度,指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签,否则规则会报数据不足),至少指定一个 param enabled: (Optional) 是否启用, 1表示启用规则,0表示禁用规则,默认为1 param multiWebHook: (Optional) 回调数组 param namespace: 命名空间 param noticeOption: (Optional) 通知策略 param region: 规则绑定资源所在地域 param ruleName: 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、’’-‘’和”_” param ruleOption: 规则的触发条件设置选项 param webHookOption: (Optional)
jdcloud_sdk.services.monitor.models.UpdateDashboardSpec module¶
jdcloud_sdk.services.monitor.models.UpdateProbeTaskSpec module¶
jdcloud_sdk.services.monitor.models.UpdateSiteMonitorSpec module¶
jdcloud_sdk.services.monitor.models.UpdateTemplateSpec module¶
-
class
jdcloud_sdk.services.monitor.models.UpdateTemplateSpec.UpdateTemplateSpec(ruleServiceCode, serviceCode, templateId, templateName, templateRules, description=None)[source]¶ Bases:
objectParameters: - description – (Optional) 模板描述
- ruleServiceCode – 规则的资源类型
- serviceCode – 模板的资源类型
- templateId – 模板ID
- templateName – 模板名称
- templateRules – 模板内包含的规则
jdcloud_sdk.services.monitor.models.UpdateWidgetSpec module¶
-
class
jdcloud_sdk.services.monitor.models.UpdateWidgetSpec.UpdateWidgetSpec(aggregated=None, createdTime=None, dashboardId=None, metrics=None, name=None, position=None, resources=None, serviceCode=None, topN=None, type=None, updatedTime=None, widgetId=None)[source]¶ Bases:
objectParameters: - aggregated – (Optional)
- createdTime – (Optional)
- dashboardId – (Optional)
- metrics – (Optional)
- name – (Optional)
- position – (Optional)
- resources – (Optional)
- serviceCode – (Optional)
- topN – (Optional)
- type – (Optional)
- updatedTime – (Optional)
- widgetId – (Optional)
jdcloud_sdk.services.monitor.models.Widget module¶
-
class
jdcloud_sdk.services.monitor.models.Widget.Widget(aggregated=None, createdTime=None, dashboardId=None, metrics=None, name=None, position=None, resources=None, serviceCode=None, topN=None, type=None, updatedTime=None, widgetId=None)[source]¶ Bases:
objectParameters: - aggregated – (Optional)
- createdTime – (Optional)
- dashboardId – (Optional)
- metrics – (Optional)
- name – (Optional)
- position – (Optional)
- resources – (Optional)
- serviceCode – (Optional)
- topN – (Optional)
- type – (Optional)
- updatedTime – (Optional)
- widgetId – (Optional)
jdcloud_sdk.services.monitor.models.WidgetDataPointItem module¶
jdcloud_sdk.services.monitor.models.WidgetMetric module¶
jdcloud_sdk.services.monitor.models.WidgetPosition module¶
-
class
jdcloud_sdk.services.monitor.models.WidgetPosition.WidgetPosition(col=None, createdTime=None, order=None, row=None, sizeX=None, sizeY=None, updatedTime=None)[source]¶ Bases:
objectParameters: - col – (Optional)
- createdTime – (Optional)
- order – (Optional)
- row – (Optional)
- sizeX – (Optional)
- sizeY – (Optional)
- updatedTime – (Optional)