CreateOrUpdateAlertRuleRequest (arms20190808 6.3.0 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.arms20190808.models.CreateOrUpdateAlertRuleRequest

public class CreateOrUpdateAlertRuleRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestMarkTags`
`static class`	`CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestTags`

字段概要

字段
限定符和类型	字段和说明
`String`	`alertCheckType` The alert check type of the Prometheus alert rule.
`Long`	`alertGroup` The alert contact group ID of the Prometheus alert rule.
`Long`	`alertId` The ID of the alert rule.
`String`	`alertName` The name of the alert rule.
`String`	`alertPiplines` The configuration of the alert sending channel.
`String`	`alertRuleContent` The content of the Application Monitoring or Browser Monitoring alert rule.
`String`	`alertStatus` The status of the alert rule.
`String`	`alertType` The following alert rule types are available: APPLICATION_MONITORING_ALERT_RULE: alert rule for Application Monitoring BROWSER_MONITORING_ALERT_RULE: alert rule for Browser Monitoring RUM_MONITORING_ALERT_RULE: alert rule for RUM Monitoring PROMETHEUS_MONITORING_ALERT_RULE: alert rule for Managed Service for Prometheus XTRACE_MONITORING_ALERT_RULE: alert rule for Managed Service for OpenTelemetry EBPF_MONITORING_ALERT_RULE: alert rule for Application Monitoring eBPF Edition This parameter is required.
`String`	`annotations` The annotations of the Prometheus alert rule.
`Boolean`	`autoAddNewApplication` Specifies whether to apply the alert rule to new applications that are created in Application Monitoring or Browser Monitoring.
`String`	`autoAddTargetConfig`
`String`	`clusterId` The ID of the monitored cluster.
`String`	`dataConfig` Data Configuration.
`Long`	`duration` The duration of the Prometheus alert rule.
`String`	`filters` The filter conditions of the Application Monitoring or Browser Monitoring alert rule.
`String`	`labels` The tags of the Prometheus alert rule.
`String`	`level` The severity level of the Prometheus alert rule.
`List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestMarkTags>`	`markTags` Application Tags.
`String`	`message` The alert message of the Prometheus alert rule.
`String`	`metricsKey` The alert metrics.
`String`	`metricsType` The metric type of the Application Monitoring or Browser Monitoring alert rule.
`String`	`notice` The effective time and notification time.
`String`	`notifyMode` Notification Mode.
`String`	`notifyStrategy` The notification policy.
`String`	`pids` The process ID (PID) that is associated with the Application Monitoring or Browser Monitoring alert rule.
`String`	`product` It is determined when creating the underlying rules of Prometheus.
`String`	`promQL` The PromQL statement of the Prometheus alert rule.
`String`	`regionId` The region ID.
`List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestTags>`	`tags` The list of tags.

构造器概要

构造器
构造器和说明

CreateOrUpdateAlertRuleRequest()

构造器
构造器和说明
`CreateOrUpdateAlertRuleRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateOrUpdateAlertRuleRequest`	`build(Map<String,?> map)`
`String`	`getAlertCheckType()`
`Long`	`getAlertGroup()`
`Long`	`getAlertId()`
`String`	`getAlertName()`
`String`	`getAlertPiplines()`
`String`	`getAlertRuleContent()`
`String`	`getAlertStatus()`
`String`	`getAlertType()`
`String`	`getAnnotations()`
`Boolean`	`getAutoAddNewApplication()`
`String`	`getAutoAddTargetConfig()`
`String`	`getClusterId()`
`String`	`getDataConfig()`
`Long`	`getDuration()`
`String`	`getFilters()`
`String`	`getLabels()`
`String`	`getLevel()`
`List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestMarkTags>`	`getMarkTags()`
`String`	`getMessage()`
`String`	`getMetricsKey()`
`String`	`getMetricsType()`
`String`	`getNotice()`
`String`	`getNotifyMode()`
`String`	`getNotifyStrategy()`
`String`	`getPids()`
`String`	`getProduct()`
`String`	`getPromQL()`
`String`	`getRegionId()`
`List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestTags>`	`getTags()`
`CreateOrUpdateAlertRuleRequest`	`setAlertCheckType(String alertCheckType)`
`CreateOrUpdateAlertRuleRequest`	`setAlertGroup(Long alertGroup)`
`CreateOrUpdateAlertRuleRequest`	`setAlertId(Long alertId)`
`CreateOrUpdateAlertRuleRequest`	`setAlertName(String alertName)`
`CreateOrUpdateAlertRuleRequest`	`setAlertPiplines(String alertPiplines)`
`CreateOrUpdateAlertRuleRequest`	`setAlertRuleContent(String alertRuleContent)`
`CreateOrUpdateAlertRuleRequest`	`setAlertStatus(String alertStatus)`
`CreateOrUpdateAlertRuleRequest`	`setAlertType(String alertType)`
`CreateOrUpdateAlertRuleRequest`	`setAnnotations(String annotations)`
`CreateOrUpdateAlertRuleRequest`	`setAutoAddNewApplication(Boolean autoAddNewApplication)`
`CreateOrUpdateAlertRuleRequest`	`setAutoAddTargetConfig(String autoAddTargetConfig)`
`CreateOrUpdateAlertRuleRequest`	`setClusterId(String clusterId)`
`CreateOrUpdateAlertRuleRequest`	`setDataConfig(String dataConfig)`
`CreateOrUpdateAlertRuleRequest`	`setDuration(Long duration)`
`CreateOrUpdateAlertRuleRequest`	`setFilters(String filters)`
`CreateOrUpdateAlertRuleRequest`	`setLabels(String labels)`
`CreateOrUpdateAlertRuleRequest`	`setLevel(String level)`
`CreateOrUpdateAlertRuleRequest`	`setMarkTags(List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestMarkTags> markTags)`
`CreateOrUpdateAlertRuleRequest`	`setMessage(String message)`
`CreateOrUpdateAlertRuleRequest`	`setMetricsKey(String metricsKey)`
`CreateOrUpdateAlertRuleRequest`	`setMetricsType(String metricsType)`
`CreateOrUpdateAlertRuleRequest`	`setNotice(String notice)`
`CreateOrUpdateAlertRuleRequest`	`setNotifyMode(String notifyMode)`
`CreateOrUpdateAlertRuleRequest`	`setNotifyStrategy(String notifyStrategy)`
`CreateOrUpdateAlertRuleRequest`	`setPids(String pids)`
`CreateOrUpdateAlertRuleRequest`	`setProduct(String product)`
`CreateOrUpdateAlertRuleRequest`	`setPromQL(String promQL)`
`CreateOrUpdateAlertRuleRequest`	`setRegionId(String regionId)`
`CreateOrUpdateAlertRuleRequest`	`setTags(List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestTags> tags)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - alertCheckType
```
@NameInMap(value="AlertCheckType")
public String alertCheckType
```
    The alert check type of the Prometheus alert rule. Valid values:
    - STATIC: a static threshold value. If you set the parameter to STATIC, you must specify the MetricsKey parameter. For more information, see the Correspondence between AlertGroup and MetricsKey for Prometheus Service table.
    - CUSTOM: a custom PromQL statement. If you set the parameter to CUSTOM, you must specify the PromQL, Duration, and Message parameters to create a Prometheus alert rule.
    example:
    STATIC
  - alertGroup
```
@NameInMap(value="AlertGroup")
public Long alertGroup
```
    The alert contact group ID of the Prometheus alert rule. Valid values:
    - \-1: custom PromQL
    - 1: Kubernetes load
    - 15: Kubernetes node
    example:
    -1
  - alertId
```
@NameInMap(value="AlertId")
public Long alertId
```
    The ID of the alert rule.
    - If you do not specify this parameter, a new alert rule is created.
    - If you specify this parameter, the specified alert rule is modified.
    example:
    546xxx
  - alertName
```
@NameInMap(value="AlertName")
public String alertName
```
    The name of the alert rule.
    
    This parameter is required.
    example:
    Alert Rule Demo
  - alertPiplines
```
@NameInMap(value="AlertPiplines")
public String alertPiplines
```
    The configuration of the alert sending channel. This parameter is used to be compatible with the old version of the rule.
    example:
  - alertRuleContent
```
@NameInMap(value="AlertRuleContent")
public String alertRuleContent
```
    The content of the Application Monitoring or Browser Monitoring alert rule. The following code provides an example of the AlertRuleContent parameter. For more information about the meaning of each field, see the supplementary description.
```
{ 
     "Condition": "OR",
      "AlertRuleItems": [
              { "Operator": "CURRENT_LTE",
                  "MetricKey": "appstat.jvm.threadcount",
                  "Value": 1000,
                  "Aggregate": "AVG",
                   "N": 10,
                   "Tolerability": 169
             } 
        ]  
   }
 
```
    The filter conditions specified by the AlertRuleItems.MetricKey field depends on the value of the MetricsType parameter. For more information about the types of metrics supported by Application Monitoring and Browser Monitoring and the alert rule fields corresponding to each metric, see the supplementary description.
    
    example:
    { "Condition": "OR", "AlertRuleItems": [ { "Operator": "CURRENT_LTE", "MetricKey": "appstat.jvm.threadcount", "Value": 1000, "Aggregate": "AVG", "N": 1 } ] }
  - alertStatus
```
@NameInMap(value="AlertStatus")
public String alertStatus
```
    The status of the alert rule. Valid values:
    - RUNNING (default)
    - STOPPED
    example:
    RUNNING
  - alertType
```
@NameInMap(value="AlertType")
public String alertType
```
    The following alert rule types are available:
    - APPLICATION_MONITORING_ALERT_RULE: alert rule for Application Monitoring
    - BROWSER_MONITORING_ALERT_RULE: alert rule for Browser Monitoring
    - RUM_MONITORING_ALERT_RULE: alert rule for RUM Monitoring
    - PROMETHEUS_MONITORING_ALERT_RULE: alert rule for Managed Service for Prometheus
    - XTRACE_MONITORING_ALERT_RULE: alert rule for Managed Service for OpenTelemetry
    - EBPF_MONITORING_ALERT_RULE: alert rule for Application Monitoring eBPF Edition
    This parameter is required.
    example:
    APPLICATION_MONITORING_ALERT_RULE
  - annotations
```
@NameInMap(value="Annotations")
public String annotations
```
    The annotations of the Prometheus alert rule.
    example:
    [ { "Value": "PolarDB slow queries", "Name": "_aliyun_display_name" }
  - autoAddNewApplication
```
@NameInMap(value="AutoAddNewApplication")
public Boolean autoAddNewApplication
```
    Specifies whether to apply the alert rule to new applications that are created in Application Monitoring or Browser Monitoring. Valid values:
    - true: enables the health check feature.
    - false: disables the automatic backup feature.
    example:
    false
  - autoAddTargetConfig
```
@NameInMap(value="AutoAddTargetConfig")
public String autoAddTargetConfig
```
  - clusterId
```
@NameInMap(value="ClusterId")
public String clusterId
```
    The ID of the monitored cluster.
    example:
    ceba9b9ea5b924dd0b6726d2de6******
  - dataConfig
```
@NameInMap(value="DataConfig")
public String dataConfig
```
    Data Configuration. The dataRevision field specifies the data repair method when there is no data for the metric.
    - Fill with zero: 0
    - Fill with one: 1
    - Fill with null: 2 (default, does not trigger an alarm)
    example:
    { "dataRevision": 2 }
  - duration
```
@NameInMap(value="Duration")
public Long duration
```
    The duration of the Prometheus alert rule. Unit: minutes.
    example:
    1
  - filters
```
@NameInMap(value="Filters")
public String filters
```
    The filter conditions of the Application Monitoring or Browser Monitoring alert rule. Format:
```
"DimFilters": [ 
 { 
  "FilterOpt": "ALL",
 "FilterValues": [],         //The value of the filter condition.
 "FilterKey": "rootIp"     //The key of the filter condition.
 }
 ]
 
```
    Valid values of FilterOpt:
    - STATIC: matches the value of the specified dimension.
    - ALL: traverses all dimension values. Dynamic thresholds do not support traversal.
    - DISABLE: aggregates the values of all dimensions.
    example:
    {"DimFilters": [ { "FilterOpt": "ALL", "FilterValues": [], "FilterKey": "rootIp" } ] }
  - labels
```
@NameInMap(value="Labels")
public String labels
```
    The tags of the Prometheus alert rule.
    example:
    [ { "Value": "cms_polardb", "Name": "_aliyun_cloud_product" } ]
  - level
```
@NameInMap(value="Level")
public String level
```
    The severity level of the Prometheus alert rule.
    - P1: Alert notifications are sent for major issues that affect the availability of core business, have a huge impact, and may lead to serious consequences.
    - P2: Alert notifications are sent for service errors that affect the system availability with relatively limited impact.
    - P3: Alert notifications are sent for issues that may cause service errors or negative effects, or alert notifications for services that are relatively less important.
    - P4: Alert notifications are sent for low-priority issues that do not affect your business.
    - Default: Alert notifications are sent regardless of alert levels.
    example:
    P2
  - markTags
```
@NameInMap(value="MarkTags")
public List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestMarkTags> markTags
```
    Application Tags. Used for application monitoring alert rules, to filter applications associated with alert rules.
  - message
```
@NameInMap(value="Message")
public String message
```
    The alert message of the Prometheus alert rule.
    example:
    Namespace: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / Container: {{$labels.container}} Memory usage exceeds 80%. Current value: {{ printf \\\\\"%.2f\\\\\" $value }}%
  - metricsKey
```
@NameInMap(value="MetricsKey")
public String metricsKey
```
    The alert metrics. If you set the AlertCheckType parameter to STATIC when you create a Prometheus alert rule, you must specify the MetricsKey parameter.
    
    Alert metrics vary depending on the value of the AlertGroup parameter. For more information about the correspondence between AlertGroup and MetricsKey, see the supplementary description.
    
    example:
    pop.status.error
  - metricsType
```
@NameInMap(value="MetricsType")
public String metricsType
```
    The metric type of the Application Monitoring or Browser Monitoring alert rule. For more information, see the following table.
    example:
    jvm
  - notice
```
@NameInMap(value="Notice")
public String notice
```
    The effective time and notification time. This parameter is used to be compatible with the old version of the rule.
    example:
  - notifyMode
```
@NameInMap(value="NotifyMode")
public String notifyMode
```
    Notification Mode. Normal mode or Simplified mode.
    example:
    NORMAL_MODE
  - notifyStrategy
```
@NameInMap(value="NotifyStrategy")
public String notifyStrategy
```
    The notification policy.
    - If you set this parameter to null, no notification policy is specified. After you create an alert rule, you can create a notification policy and specify match rules and match conditions. For example, you can specify the name of the alert rule as the match condition. When the alert rule is triggered, an alert event is generated and an alert notification is sent to the contacts or contact groups that are specified in the notification policy.
    - To specify a notification policy, set this parameter to the ID of the notification policy. Application Real-Time Monitoring Service (ARMS) automatically adds a match rule to the notification policy and specifies the ID of the alert rule as the match condition. The name of the alert rule is also displayed. This way, the alert events that are generated based on the alert rule can be matched by the specified notification policy.
    example:
    569xxx
  - pids
```
@NameInMap(value="Pids")
public String pids
```
    The process ID (PID) that is associated with the Application Monitoring or Browser Monitoring alert rule.
    example:
    ["b590lhguqs@40d8deedfa9******"]
  - product
```
@NameInMap(value="Product")
public String product
```
    It is determined when creating the underlying rules of Prometheus. The background will verify whether the product exists, which is used to distinguish cloud product filtering queries.
    example:
    xxxx
  - promQL
```
@NameInMap(value="PromQL")
public String promQL
```
    The PromQL statement of the Prometheus alert rule.
    example:
    node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID.
    
    This parameter is required.
    example:
    cn-hangzhou
  - tags
```
@NameInMap(value="Tags")
public List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestTags> tags
```
    The list of tags.
- 构造器详细资料
  - CreateOrUpdateAlertRuleRequest
```
public CreateOrUpdateAlertRuleRequest()
```
- 方法详细资料
  - build
```
public static CreateOrUpdateAlertRuleRequest build(Map<String,?> map)
                                            throws Exception
```
    抛出:
    
    Exception
  - setAlertCheckType
```
public CreateOrUpdateAlertRuleRequest setAlertCheckType(String alertCheckType)
```
  - getAlertCheckType
```
public String getAlertCheckType()
```
  - setAlertGroup
```
public CreateOrUpdateAlertRuleRequest setAlertGroup(Long alertGroup)
```
  - getAlertGroup
```
public Long getAlertGroup()
```
  - setAlertId
```
public CreateOrUpdateAlertRuleRequest setAlertId(Long alertId)
```
  - getAlertId
```
public Long getAlertId()
```
  - setAlertName
```
public CreateOrUpdateAlertRuleRequest setAlertName(String alertName)
```
  - getAlertName
```
public String getAlertName()
```
  - setAlertPiplines
```
public CreateOrUpdateAlertRuleRequest setAlertPiplines(String alertPiplines)
```
  - getAlertPiplines
```
public String getAlertPiplines()
```
  - setAlertRuleContent
```
public CreateOrUpdateAlertRuleRequest setAlertRuleContent(String alertRuleContent)
```
  - getAlertRuleContent
```
public String getAlertRuleContent()
```
  - setAlertStatus
```
public CreateOrUpdateAlertRuleRequest setAlertStatus(String alertStatus)
```
  - getAlertStatus
```
public String getAlertStatus()
```
  - setAlertType
```
public CreateOrUpdateAlertRuleRequest setAlertType(String alertType)
```
  - getAlertType
```
public String getAlertType()
```
  - setAnnotations
```
public CreateOrUpdateAlertRuleRequest setAnnotations(String annotations)
```
  - getAnnotations
```
public String getAnnotations()
```
  - setAutoAddNewApplication
```
public CreateOrUpdateAlertRuleRequest setAutoAddNewApplication(Boolean autoAddNewApplication)
```
  - getAutoAddNewApplication
```
public Boolean getAutoAddNewApplication()
```
  - setAutoAddTargetConfig
```
public CreateOrUpdateAlertRuleRequest setAutoAddTargetConfig(String autoAddTargetConfig)
```
  - getAutoAddTargetConfig
```
public String getAutoAddTargetConfig()
```
  - setClusterId
```
public CreateOrUpdateAlertRuleRequest setClusterId(String clusterId)
```
  - getClusterId
```
public String getClusterId()
```
  - setDataConfig
```
public CreateOrUpdateAlertRuleRequest setDataConfig(String dataConfig)
```
  - getDataConfig
```
public String getDataConfig()
```
  - setDuration
```
public CreateOrUpdateAlertRuleRequest setDuration(Long duration)
```
  - getDuration
```
public Long getDuration()
```
  - setFilters
```
public CreateOrUpdateAlertRuleRequest setFilters(String filters)
```
  - getFilters
```
public String getFilters()
```
  - setLabels
```
public CreateOrUpdateAlertRuleRequest setLabels(String labels)
```
  - getLabels
```
public String getLabels()
```
  - setLevel
```
public CreateOrUpdateAlertRuleRequest setLevel(String level)
```
  - getLevel
```
public String getLevel()
```
  - setMarkTags
```
public CreateOrUpdateAlertRuleRequest setMarkTags(List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestMarkTags> markTags)
```
  - getMarkTags
```
public List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestMarkTags> getMarkTags()
```
  - setMessage
```
public CreateOrUpdateAlertRuleRequest setMessage(String message)
```
  - getMessage
```
public String getMessage()
```
  - setMetricsKey
```
public CreateOrUpdateAlertRuleRequest setMetricsKey(String metricsKey)
```
  - getMetricsKey
```
public String getMetricsKey()
```
  - setMetricsType
```
public CreateOrUpdateAlertRuleRequest setMetricsType(String metricsType)
```
  - getMetricsType
```
public String getMetricsType()
```
  - setNotice
```
public CreateOrUpdateAlertRuleRequest setNotice(String notice)
```
  - getNotice
```
public String getNotice()
```
  - setNotifyMode
```
public CreateOrUpdateAlertRuleRequest setNotifyMode(String notifyMode)
```
  - getNotifyMode
```
public String getNotifyMode()
```
  - setNotifyStrategy
```
public CreateOrUpdateAlertRuleRequest setNotifyStrategy(String notifyStrategy)
```
  - getNotifyStrategy
```
public String getNotifyStrategy()
```
  - setPids
```
public CreateOrUpdateAlertRuleRequest setPids(String pids)
```
  - getPids
```
public String getPids()
```
  - setProduct
```
public CreateOrUpdateAlertRuleRequest setProduct(String product)
```
  - getProduct
```
public String getProduct()
```
  - setPromQL
```
public CreateOrUpdateAlertRuleRequest setPromQL(String promQL)
```
  - getPromQL
```
public String getPromQL()
```
  - setRegionId
```
public CreateOrUpdateAlertRuleRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setTags
```
public CreateOrUpdateAlertRuleRequest setTags(List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestTags> tags)
```
  - getTags
```
public List<CreateOrUpdateAlertRuleRequest.CreateOrUpdateAlertRuleRequestTags> getTags()
```

类 CreateOrUpdateAlertRuleRequest

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

alertCheckType

alertGroup

alertId

alertName

alertPiplines

alertRuleContent

alertStatus

alertType

annotations

autoAddNewApplication

autoAddTargetConfig

clusterId

dataConfig

duration

filters

labels

level

markTags

message

metricsKey

metricsType

notice

notifyMode

notifyStrategy

pids

product

promQL

regionId

tags

构造器详细资料

CreateOrUpdateAlertRuleRequest

方法详细资料

build

setAlertCheckType

getAlertCheckType

setAlertGroup

getAlertGroup

setAlertId

getAlertId

setAlertName

getAlertName

setAlertPiplines

getAlertPiplines

setAlertRuleContent

getAlertRuleContent

setAlertStatus

getAlertStatus

setAlertType

getAlertType

setAnnotations

getAnnotations

setAutoAddNewApplication

getAutoAddNewApplication

setAutoAddTargetConfig

getAutoAddTargetConfig

setClusterId

getClusterId

setDataConfig

getDataConfig

setDuration

getDuration

setFilters

getFilters

setLabels

getLabels

setLevel

getLevel

setMarkTags

getMarkTags

setMessage

getMessage

setMetricsKey