Skip to content

GroupMetricRuleProps

Properties for defining a GroupMetricRule.

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

Initializer 

import { GroupMetricRuleProps } from '@alicloud/ros-cdk-cms'
const groupMetricRuleProps: GroupMetricRuleProps = { ... }

Properties

Name Type Description
category string | @alicloud/ros-cdk-core.IResolvable Property category: The abbreviation of the service name.
escalations @alicloud/ros-cdk-core.IResolvable | EscalationsProperty Property escalations: undefined.
groupId string | @alicloud/ros-cdk-core.IResolvable Property groupId: The ID of application group.
metricName string | @alicloud/ros-cdk-core.IResolvable Property metricName: The name of the metric.
namespace string | @alicloud/ros-cdk-core.IResolvable Property namespace: The data namespace of the service.
ruleId string | @alicloud/ros-cdk-core.IResolvable Property ruleId: The ID of the alert rule.
ruleName string | @alicloud/ros-cdk-core.IResolvable Property ruleName: The name of the alert rule.
dimensions string | @alicloud/ros-cdk-core.IResolvable Property dimensions: The expended resource dimensions.
effectiveInterval string | @alicloud/ros-cdk-core.IResolvable Property effectiveInterval: The period when the alert rule is effective.
emailSubject string | @alicloud/ros-cdk-core.IResolvable Property emailSubject: The subject of the alert notification email.
interval number | @alicloud/ros-cdk-core.IResolvable Property interval: The detection period of alerts.
noEffectiveInterval string | @alicloud/ros-cdk-core.IResolvable Property noEffectiveInterval: The period when the alert rule is ineffective.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The aggregation period.
silenceTime number | @alicloud/ros-cdk-core.IResolvable Property silenceTime: The duration of the mute period during which new alerts are not sent even if the trigger conditions are met.
webhook string | @alicloud/ros-cdk-core.IResolvable Property webhook: The URL of the callback triggered when an alert occurs.

categoryRequired 

public readonly category: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly escalations: IResolvable | EscalationsProperty;

Property escalations: undefined.

groupIdRequired 

public readonly groupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property groupId: The ID of application group.

metricNameRequired 

public readonly metricName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property metricName: The name of the metric.

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

namespaceRequired 

public readonly namespace: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property namespace: The data namespace of the service.

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

ruleIdRequired 

public readonly ruleId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ruleId: The ID of the alert rule.

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

ruleNameRequired 

public readonly ruleName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ruleName: The name of the alert rule.

dimensionsOptional 

public readonly dimensions: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dimensions: The expended resource dimensions.

effectiveIntervalOptional 

public readonly effectiveInterval: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

emailSubjectOptional 

public readonly emailSubject: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property emailSubject: The subject of the alert notification email.

intervalOptional 

public readonly interval: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property interval: The detection period of alerts.

noEffectiveIntervalOptional 

public readonly noEffectiveInterval: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The aggregation period.

Unite: second.

silenceTimeOptional 

public readonly silenceTime: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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 readonly webhook: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property webhook: The URL of the callback triggered when an alert occurs.