Skip to content

GroupMetricRuleProps

Properties for defining a GroupMetricRule.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cms-groupmetricrule

Initializer

using AlibabaCloud.SDK.ROS.CDK.Cms;
new GroupMetricRuleProps {
    object Category,
    object Escalations,
    object GroupId,
    object MetricName,
    object Namespace,
    object RuleId,
    object RuleName,
    object ContactGroups = null,
    object Dimensions = null,
    object EffectiveInterval = null,
    object EmailSubject = null,
    object ExtraDimensionJson = null,
    object Interval = null,
    object NoDataPolicy = null,
    object NoEffectiveInterval = null,
    object Options = null,
    object Period = null,
    object SilenceTime = null,
    object Webhook = null
};

Properties

Name Type Description
Category object Property category: The abbreviation of the service name.
Escalations object Property escalations: undefined.
GroupId object Property groupId: The ID of application group.
MetricName object Property metricName: The name of the metric.
Namespace object Property namespace: The data namespace of the service.
RuleId object Property ruleId: The ID of the alert rule.
RuleName object Property ruleName: The name of the alert rule.
ContactGroups object Property contactGroups: The alert contact groups.
Dimensions object Property dimensions: The dimensions that specify the resources to be monitored.
EffectiveInterval object Property effectiveInterval: The period when the alert rule is effective.
EmailSubject object Property emailSubject: The subject of the alert notification email.
ExtraDimensionJson object Property extraDimensionJson: The secondary or tertiary dimensions of the alert rule in the application group.
Interval object Property interval: The interval at which the alert rule is triggered.
NoDataPolicy object Property noDataPolicy: The handling method when there is no monitoring data.
NoEffectiveInterval object Property noEffectiveInterval: The period when the alert rule is ineffective.
Options object Property options: The advanced settings.
Period object Property period: The statistical period of the metric.
SilenceTime object Property silenceTime: The duration of the mute period during which new alerts are not sent even if the trigger conditions are met.
Webhook object Property webhook: The callback URL to which alert notifications are sent.

CategoryRequired

public object Category { get; set; }
  • Type: object

Property category: The abbreviation of the service name.

Valid values: ECS (including Alibaba Cloud and non-Alibaba Cloud hosts) RDS (ApsaraDB for RDS) ADS (AnalyticDB) SLB (Server Load Balancer) VPC (Virtual Private Cloud) APIGATEWAY (API Gateway) CDN CS (Container Service for Swarm) DCDN (Dynamic Route for CDN) DDoS (distributed denial of service) EIP (Elastic IP) ELASTICSEARCH (Elasticsearch) EMR (E-MapReduce) ESS (Auto Scaling) HBASE (ApsaraDB for HBase) IOT_EDGE (IoT Edge) K8S_POD (k8s pod) KVSTORE_SHARDING (ApsaraDB for Redis cluster version) KVSTORE_SPLITRW (ApsaraDB for Redis read/write splitting version) KVSTORE_STANDARD (ApsaraDB for Redis standard version) MEMCACHE (ApsaraDB for Memcache) MNS (Message Service) MONGODB (ApsaraDB for MongoDB replica set instances) MONGODB_CLUSTER (ApsaraDB for MongoDB cluster version) MONGODB_SHARDING (ApsaraDB for MongoDB sharded clusters) MQ_TOPIC (Message Service topic) OCS (original version of ApsaraDB for Memcache) OPENSEARCH (Open Search) OSS (Object Storage Service) POLARDB (ApsaraDB for POLARDB) PETADATA (HybridDB for MySQL) SCDN (Secure Content Delivery Network) SHAREBANDWIDTHPACKAGES (shared bandwidth package) SLS (Log Service) VPN (VPN Gateway)


EscalationsRequired

public object Escalations { get; set; }
  • Type: object

Property escalations: undefined.


GroupIdRequired

public object GroupId { get; set; }
  • Type: object

Property groupId: The ID of application group.


MetricNameRequired

public object MetricName { get; set; }
  • Type: object

Property metricName: The name of the metric.

For more information, call DescribeMetricMetaList or see Preset metrics reference.


NamespaceRequired

public object Namespace { get; set; }
  • Type: object

Property namespace: The data namespace of the service.

For more information, call DescribeMetricMetaList or see Preset metrics reference.


RuleIdRequired

public object RuleId { get; set; }
  • Type: object

Property ruleId: The ID of the alert rule.

The IDs of alert rules are generated by callers to ensure uniqueness.


RuleNameRequired

public object RuleName { get; set; }
  • Type: object

Property ruleName: The name of the alert rule.


ContactGroupsOptional

public object ContactGroups { get; set; }
  • Type: object

Property contactGroups: The alert contact groups.


DimensionsOptional

public object Dimensions { get; set; }
  • Type: object

Property dimensions: The dimensions that specify the resources to be monitored.

The value is a collection of key-value pairs. Format: key:value. For example, {"userId":"120886317861**"} and {"instanceId":"i-2ze2d6j5uhg20x47**"}.


EffectiveIntervalOptional

public object EffectiveInterval { get; set; }
  • Type: object

Property effectiveInterval: The period when the alert rule is effective.


EmailSubjectOptional

public object EmailSubject { get; set; }
  • Type: object

Property emailSubject: The subject of the alert notification email.


ExtraDimensionJsonOptional

public object ExtraDimensionJson { get; set; }
  • Type: object

Property extraDimensionJson: The secondary or tertiary dimensions of the alert rule in the application group.

Format: a collection of key:value pairs, for example, port:80 or \/dev\/xvda:d-m5e6yphgzn3aprwu****.

When the first-level dimension of the alert rule is {"instanceId":"i-m5e1qg6uo38rztr4****"}, its secondary dimension is the disk {"\/dev\/xvda":"d-m5e6yphgzn3aprwu****"}.


IntervalOptional

public object Interval { get; set; }
  • Type: object

Property interval: The interval at which the alert rule is triggered.

Unit: seconds.

Set the alert detection interval to the same value as the data reporting interval. If the alert detection interval is shorter than the data reporting interval, alerts may not be triggered due to insufficient data.


NoDataPolicyOptional

public object NoDataPolicy { get; set; }
  • Type: object

Property noDataPolicy: The handling method when there is no monitoring data.

Valid values:

  • KEEP_LAST_STATE (default): No action is taken.
  • INSUFFICIENT_DATA: Alert content is "No Data".
  • OK: Normal.

NoEffectiveIntervalOptional

public object NoEffectiveInterval { get; set; }
  • Type: object

Property noEffectiveInterval: The period when the alert rule is ineffective.


OptionsOptional

public object Options { get; set; }
  • Type: object

Property options: The advanced settings.

Format: {"key1":"value1","key2":"value2"}, for example, {"NotSendOK":true}, indicating whether to send alert recovery notifications. The key is NotSendOK, and the value is true (do not send) or false (send by default).


PeriodOptional

public object Period { get; set; }
  • Type: object

Property period: The statistical period of the metric.

The value of Period must be an integral multiple of 60. Unit: seconds. Default value: 300.


SilenceTimeOptional

public object SilenceTime { get; set; }
  • Type: object

Property silenceTime: The duration of the mute period during which new alerts are not sent even if the trigger conditions are met.

Unit: second. Default value: 86400. Minimum value: 60.


WebhookOptional

public object Webhook { get; set; }
  • Type: object

Property webhook: The callback URL to which alert notifications are sent.

Enter a URL that is accessible over the Internet. CloudMonitor sends alert notifications to the URL using POST requests. Only the HTTP protocol is supported.