jdcloud_sdk.services.monitor.apis package

Submodules

jdcloud_sdk.services.monitor.apis.CreateAlarmRequest module

class jdcloud_sdk.services.monitor.apis.CreateAlarmRequest.CreateAlarmParameters(clientToken, product, resourceOption, ruleName, ruleOption)[source]

Bases: object

Parameters:
  • clientToken – 幂等性校验参数,最长36位,若两个请求clientToken相等，则返回第一次创建的规则id，只创建一次规则
  • product – 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。
  • resourceOption –
  • ruleName – 规则名称，规则名称，最大长度42个字符，只允许中英文、数字、’’-‘’和”_”
  • ruleOption –
setAutoScalingPolicyId(autoScalingPolicyId)[source]
Parameters:autoScalingPolicyId – (Optional) 弹性伸缩组Id。注：仅agsg产品线内部使用
setBaseContact(baseContact)[source]
Parameters:baseContact – (Optional) 告警通知联系人
setDataOwner(dataOwner)[source]
Parameters:dataOwner – (Optional) 数据所有者，1云监控控制台; 2云鼎。默认为1
setDimension(dimension)[source]
Parameters:dimension – (Optional) 资源维度，可用的维度请使用 describeProductsForAlarm接口查询
setEnabled(enabled)[source]
Parameters:enabled – (Optional) 是否启用, 1表示启用规则，0表示禁用规则，默认为1
setMultiWebHook(multiWebHook)[source]
Parameters:multiWebHook – (Optional) url回调设置数组
setNoticeOption(noticeOption)[source]
Parameters:noticeOption – (Optional) 通知策略
setRuleType(ruleType)[source]
Parameters:ruleType – (Optional) 规则类型, 默认为resourceMonitor
setTags(tags)[source]
Parameters:tags – (Optional) 资源维度，指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签，否则规则会报数据不足)
setWebHookOption(webHookOption)[source]
Parameters:webHookOption – (Optional)
class jdcloud_sdk.services.monitor.apis.CreateAlarmRequest.CreateAlarmRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建报警规则

jdcloud_sdk.services.monitor.apis.DeleteAlarmsCmRequest module

jdcloud_sdk.services.monitor.apis.DeleteAlarmsRequest module

class jdcloud_sdk.services.monitor.apis.DeleteAlarmsRequest.DeleteAlarmsParameters(alarmId)[source]

Bases: object

Parameters:alarmId – 规则id
class jdcloud_sdk.services.monitor.apis.DeleteAlarmsRequest.DeleteAlarmsRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除规则

jdcloud_sdk.services.monitor.apis.DescribeAlarmContactsRequest module

class jdcloud_sdk.services.monitor.apis.DescribeAlarmContactsRequest.DescribeAlarmContactsParameters(alarmId)[source]

Bases: object

Parameters:alarmId – 规则id
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 当前所在页，默认为1
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 页面大小，默认为20；取值范围[1, 100]
setReferenceType(referenceType)[source]
Parameters:referenceType – (Optional) 联系人类型。0,联系人分组; 1,联系人
class jdcloud_sdk.services.monitor.apis.DescribeAlarmContactsRequest.DescribeAlarmContactsRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询规则的报警联系人

jdcloud_sdk.services.monitor.apis.DescribeAlarmHistoryAllRegionRequest module

jdcloud_sdk.services.monitor.apis.DescribeAlarmHistoryRequest module

class jdcloud_sdk.services.monitor.apis.DescribeAlarmHistoryRequest.DescribeAlarmHistoryParameters[source]

Bases: object

setDataOwner(dataOwner)[source]
Parameters:dataOwner – (Optional) 数据所有者，1云监控控制台; 2云鼎。默认为1
setDimension(dimension)[source]
Parameters:dimension – (Optional) 维度标识、指定该参数时，查询只返回该维度的数据。如redis2.8cluster下存在实例、分片等多个维度
setEndTime(endTime)[source]
Parameters:endTime – (Optional) 结束时间
setFilters(filters)[source]
param filters:(Optional) serviceCodes - 产品线servicecode，精确匹配，支持多个

resourceIds - 资源Id，精确匹配，支持多个（必须指定serviceCode才会在该serviceCode下根据resourceIds过滤，否则该参数不生效） alarmIds - 规则Id，精确匹配，支持多个

setIsAlarming(isAlarming)[source]
Parameters:isAlarming – (Optional) 正在报警, 取值为1
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 当前所在页，默认为1
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 页面大小，默认为20；取值范围[1, 100]
setProduct(product)[source]
Parameters:product – (Optional) 产品标识,默认返回该product下所有dimension的数据。eg:product=redis2.8cluster（redis2.8cluster产品下包含redis2.8-shard与redis2.8-proxy、redis2.8-instance多个维度)。
setRegion(region)[source]
Parameters:region – (Optional) 根据region筛选对应region的资源的报警历史
setRuleName(ruleName)[source]
Parameters:ruleName – (Optional) 规则名称模糊搜索
setRuleType(ruleType)[source]
Parameters:ruleType – (Optional) 规则类型,默认查询1， 1表示资源监控，6表示站点监控,7表示可用性监控
setServiceCode(serviceCode)[source]
Parameters:serviceCode – (Optional) 产品线标识，同一个产品线下可能存在多个product，如(redis下有redis2.8cluster、redis4.0)
setStartTime(startTime)[source]
Parameters:startTime – (Optional) 开始时间
setStatus(status)[source]
Parameters:status – (Optional) 报警的状态,1为报警恢复、2为报警、4为报警恢复无数据
class jdcloud_sdk.services.monitor.apis.DescribeAlarmHistoryRequest.DescribeAlarmHistoryRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询报警历史

jdcloud_sdk.services.monitor.apis.DescribeAlarmsByIDRequest module

jdcloud_sdk.services.monitor.apis.DescribeAlarmsRequest module

class jdcloud_sdk.services.monitor.apis.DescribeAlarmsRequest.DescribeAlarmsParameters[source]

Bases: object

setDataOwner(dataOwner)[source]
Parameters:dataOwner – (Optional) 数据所有者，1云监控控制台; 2云鼎。默认为1
setDimension(dimension)[source]
Parameters:dimension – (Optional) 产品下的维度标识，指定dimension时必须指定product
setEnabled(enabled)[source]
Parameters:enabled – (Optional) 规则状态：1为启用，0为禁用
setFilters(filters)[source]
param filters:(Optional) 服务码或资源Id列表

products - 产品product，精确匹配，支持多个 resourceIds - 资源Id，精确匹配，支持多个（必须指定serviceCode、product或dimension，否则该参数不生效） alarmIds - 规则id，精确匹配，支持多个

setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 当前所在页，默认为1
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 页面大小，默认为20；取值范围[1, 100]
setProduct(product)[source]
Parameters:product – (Optional) 产品标识，如redis下分多个产品(redis2.8cluster、redis4.0)。同时指定serviceCode与product时，product优先生效
setRuleName(ruleName)[source]
Parameters:ruleName – (Optional) 规则名称
setRuleStatus(ruleStatus)[source]
Parameters:ruleStatus – (Optional) 资源的规则状态 2：报警、4：数据不足
setRuleType(ruleType)[source]
Parameters:ruleType – (Optional) 规则类型, 1表示资源监控，6表示站点监控,7表示可用性监控
setServiceCode(serviceCode)[source]
Parameters:serviceCode – (Optional) 产品线标识，同一个产品线下可能存在多个product，如(redis下有redis2.8cluster、redis4.0)
class jdcloud_sdk.services.monitor.apis.DescribeAlarmsRequest.DescribeAlarmsRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询规则列表

jdcloud_sdk.services.monitor.apis.DescribeMetricDataRequest module

class jdcloud_sdk.services.monitor.apis.DescribeMetricDataRequest.DescribeMetricDataParameters(regionId, metric, resourceId)[source]

Bases: object

Parameters:
  • regionId – 地域 Id
  • metric – 监控项英文标识(id)
  • resourceId – 资源的uuid
setAggrType(aggrType)[source]
Parameters:aggrType – (Optional) 聚合方式，用于不同时间轴上的聚合。如balance产品同一个resourceId下存在port=80和port=8080等多种维度。可选值参考:sum、avg、min、max
setDimension(dimension)[source]
Parameters:dimension – (Optional) 资源的维度。查询serviceCode下可用的维度请使用describeServices接口
setDownSampleType(downSampleType)[source]
Parameters:downSampleType – (Optional) 采样方式，用于在时间轴维度上将聚合周期内的数据聚合为一个点。可选值参考：sum(聚合周期内的数据求和)、avg(求平均)、last(最新值)、min(最小值)、max(最大值)
setEndTime(endTime)[source]
param endTime:(Optional) 查询时间范围的结束时间, UTC时间，格式：2016-12-11T00:00:00+0800（为空时，将由startTime与timeInterval计算得出）（注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800）

默认为当前时间,结束时间不得晚于当前时间. 如果晚于, 会被默认设成当前时间, 结束时间不得早于 30 天前.

setGroupBy(groupBy)[source]
Parameters:groupBy – (Optional) 是否对查询的tags分组
setRate(rate)[source]
Parameters:rate – (Optional) 是否求速率。仅对累积类型指标有意义, 默认 false
setServiceCode(serviceCode)[source]
Parameters:serviceCode – (Optional) 资源的类型，取值vm, lb, ip, database 等,<a href=”https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud”>describeServices</a>：查询己接入云监控的产品线列表
setStartTime(startTime)[source]
param startTime:
 (Optional) 查询时间范围的开始时间， UTC时间，格式：2016-12-11T00:00:00+0800（注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800）

开始时间不得晚于当前时间,开始时间不得早于 30 天前

setTags(tags)[source]
Parameters:tags – (Optional) 监控指标数据的维度信息,根据tags来筛选指标数据不同的维度
setTimeInterval(timeInterval)[source]
param timeInterval:
 (Optional) 时间间隔：1h，6h，12h，1d，3d，7d，14d，固定时间间隔，timeInterval默认为1h，当前时间往 前1h

如果指定了 startTime 和 endTime,可以不用设置. 默认的,三个参数都不设置查询 1h 内数据. timeInterval 默认值 1h endTime 默认值, 当前时间 startTime 默认值, endTime - timeInterval

class jdcloud_sdk.services.monitor.apis.DescribeMetricDataRequest.DescribeMetricDataRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看某资源单个监控项数据.

metric介绍: <a href=”https://docs.jdcloud.com/cn/monitoring/metrics”>Metrics</a> 可以使用接口:<a href=”https://docs.jdcloud.com/cn/monitoring/metrics”>describeMetrics</a>:查询产品线可用的metric列表。 查询起止时间统一向下对齐10s, 举例:开始时间为 08:45:45 会对齐到08:45:40

jdcloud_sdk.services.monitor.apis.DescribeMetricsForCreateAlarmRequest module

jdcloud_sdk.services.monitor.apis.DescribeMetricsRequest module

class jdcloud_sdk.services.monitor.apis.DescribeMetricsRequest.DescribeMetricsParameters(serviceCode)[source]

Bases: object

Parameters:serviceCode – 资源的类型，取值vm, lb, ip, database 等。<a href=”https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud”>describeServices</a>：查询己接入云监控的产品线列表
setDimension(dimension)[source]
Parameters:dimension – (Optional)
setType(type)[source]
Parameters:type – (Optional) metric的类型，取值0(控制台展示)、1(内部使用，控制台不展示)、2(所有).默认取0
class jdcloud_sdk.services.monitor.apis.DescribeMetricsRequest.DescribeMetricsRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

根据产品线查询可用监控项列表,metric介绍：<a href=”https://docs.jdcloud.com/cn/monitoring/metrics”>Metrics</a>

jdcloud_sdk.services.monitor.apis.DisableAlarmRequest module

jdcloud_sdk.services.monitor.apis.EnableAlarmRequest module

jdcloud_sdk.services.monitor.apis.LastDownsampleRequest module

class jdcloud_sdk.services.monitor.apis.LastDownsampleRequest.LastDownsampleParameters(regionId, metric, serviceCode, resourceId)[source]

Bases: object

Parameters:
  • regionId – 地域 Id
  • metric – 监控项英文标识(id)
  • serviceCode – 资源的类型，取值vm, lb, ip, database 等。可用的serviceCode请使用describeServices接口查询
  • resourceId – 资源的uuid，支持多个resourceId批量查询，每个id用竖线分隔。 如：id1|id2|id3|id4
setAggrType(aggrType)[source]
Parameters:aggrType – (Optional) 聚合方式：max avg min等,用于不同维度之间聚合
setDimension(dimension)[source]
Parameters:dimension – (Optional) 资源的维度。serviceCode下可用的dimension请使用describeServices接口查询
setDownAggrType(downAggrType)[source]
Parameters:downAggrType – (Optional) 聚合方式：max avg min等,用于将维度内一个周期数据聚合为一个点的聚合方式,默认last
setEndTime(endTime)[source]
Parameters:endTime – (Optional) 查询时间范围的结束时间， UTC时间，格式：2016-12-11T00:00:00+0800（为空时，将由startTime与timeInterval计算得出）（注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800）
setStartTime(startTime)[source]
Parameters:startTime – (Optional) 查询时间范围的开始时间， UTC时间，格式：2016-12-11T00:00:00+0800（早于30d时，将被重置为30d）（注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800）
setTags(tags)[source]
Parameters:tags – (Optional) 自定义标签
setTimeInterval(timeInterval)[source]
Parameters:timeInterval – (Optional) 查询的时间间隔，最大不超过30天，支持分钟级别,小时级别，天级别，例如：1m、1h、1d
setTimeOffset(timeOffset)[source]
Parameters:timeOffset – (Optional) 时间偏移，可传入30s、1m、1h、1d等数字+单位的形式(其中s秒，m分，h时，d天)，当业务侧数据上报存在延迟时，可以传入该参数，该参数会使查询的时间段整体向前偏移.偏移后的开始时间若早于30天前,则开始时间自动设置为30天前;若偏移后结束时间早于30天前，则无效
class jdcloud_sdk.services.monitor.apis.LastDownsampleRequest.LastDownsampleRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

根据不同的聚合方式将metric的数据聚合为一个点。downAggrType：last(最后一个点)、max(最大值)、min(最小值)、avg(平均值)。该接口返回值为上报metric的原始值，没有做单位转换。metric介绍：<a href=”https://docs.jdcloud.com/cn/monitoring/metrics”>Metrics</a>

jdcloud_sdk.services.monitor.apis.PutMetricDataRequest module

class jdcloud_sdk.services.monitor.apis.PutMetricDataRequest.PutMetricDataParameters[source]

Bases: object

setMetricDataList(metricDataList)[source]
Parameters:metricDataList – (Optional) 数据参数
class jdcloud_sdk.services.monitor.apis.PutMetricDataRequest.PutMetricDataRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

该接口为自定义监控数据上报的接口，方便您将自己采集的时序数据上报到云监控。不同region域名上报不同region的数据，参考：<a href=”https://docs.jdcloud.com/cn/monitoring/reporting-monitoring-data”>调用说明</a>可上报原始数据和已聚合的统计数据。支持批量上报方式。单次请求最多包含 50 个数据点；数据大小不超过 256k。

jdcloud_sdk.services.monitor.apis.UpdateAlarmRequest module

class jdcloud_sdk.services.monitor.apis.UpdateAlarmRequest.UpdateAlarmParameters(alarmId, product, resourceOption, ruleName, ruleOption)[source]

Bases: object

Parameters:
  • alarmId – 规则id
  • product – 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。
  • resourceOption –
  • ruleName – 规则名称，规则名称，最大长度42个字符，只允许中英文、数字、’’-‘’和”_”
  • ruleOption –
setAutoScalingPolicyId(autoScalingPolicyId)[source]
Parameters:autoScalingPolicyId – (Optional) 弹性伸缩组Id。注：仅agsg产品线内部使用
setBaseContact(baseContact)[source]
Parameters:baseContact – (Optional) 告警通知联系人
setDataOwner(dataOwner)[source]
Parameters:dataOwner – (Optional) 数据所有者，1云监控控制台; 2云鼎。默认为1
setDimension(dimension)[source]
Parameters:dimension – (Optional) 资源维度，可用的维度请使用 describeProductsForAlarm接口查询
setEnabled(enabled)[source]
Parameters:enabled – (Optional) 是否启用, 1表示启用规则，0表示禁用规则，默认为1
setMultiWebHook(multiWebHook)[source]
Parameters:multiWebHook – (Optional) url回调设置数组
setNoticeOption(noticeOption)[source]
Parameters:noticeOption – (Optional) 通知策略
setRuleType(ruleType)[source]
Parameters:ruleType – (Optional) 规则类型, 默认为resourceMonitor
setTags(tags)[source]
Parameters:tags – (Optional) 资源维度，指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签，否则规则会报数据不足)
setWebHookOption(webHookOption)[source]
Parameters:webHookOption – (Optional)
class jdcloud_sdk.services.monitor.apis.UpdateAlarmRequest.UpdateAlarmRequest(parameters, header=None, version='v2')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改已创建的报警规则

Module contents