DocsICP FilingConsole
官方文档
首页

PutGroupMetricRule

更新时间：
复制 MD 格式
产品详情
我的收藏

Creates or modifies an alert rule in a specified application group.

Operation description

This topic provides an example on how to create an alert rule for the cpu_total metric of Elastic Compute Service (ECS) in the application group 17285****. The alert rule ID is 123456, the alert rule name is Rule_test, the alert severity is Critical, the statistical method is Average, the comparison operator is GreaterThanOrEqualToThreshold, the threshold is 90, and the retry count is 3. The response shows that the alert rule is created. The alert rule ID is 123456.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:PutGroupMetricRule

create

*GroupMetricRule

acs:cms::{#accountId}:group/{#groupId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
GroupId

string

Yes

The application group ID.

For information about how to obtain the application group ID, see DescribeMonitorGroups.

17285****
RuleId

string

Yes

The alert rule ID.

  • To create an alert rule for the application group, enter an alert rule ID.

  • To modify a specified alert rule in the application group, obtain the alert rule ID. For information about how to obtain the alert rule ID, see DescribeMetricRuleList.

123456
Category

string

No

The abbreviation of the Alibaba Cloud service name.

For information about how to obtain the abbreviation, see the metricCategory tag in the Labels response parameter of the DescribeProjectMeta operation.

ECS
RuleName

string

Yes

The alert rule name.

  • To create an alert rule for the application group, enter an alert rule name.

  • To modify a specified alert rule in the application group, obtain the alert rule name. For information about how to obtain the alert rule name, see DescribeMetricRuleList.

Rule_01
Namespace

string

Yes

The namespace of the Alibaba Cloud service.

For information about how to obtain the namespace, see DescribeMetricMetaList or Cloud service monitoring.

acs_ecs_dashboard
MetricName

string

Yes

The metric name.

For information about how to obtain the metric name, see DescribeMetricMetaList or Cloud service monitoring.

cpu_total
Dimensions

string

No

The first-level dimensions of the alert rule in the application group.

Format: a collection of key:value pairs, such as {"userId":"120886317861****"} and {"instanceId":"i-m5e1qg6uo38rztr4****"}.

[{"instanceId":"i-m5e1qg6uo38rztr4****"}]
ExtraDimensionJson

string

No

The second-level or third-level dimensions of the alert rule in the application group.

Format: a collection of key:value pairs, such as port:80 and /dev/xvda:d-m5e6yphgzn3aprwu****.

If the first-level dimension is {"instanceId":"i-m5e1qg6uo38rztr4****"}, the second-level dimension is a cloud disk of the instance: {"/dev/xvda":"d-m5e6yphgzn3aprwu****"}.

{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}
EffectiveInterval

string

No

The effective period during which the alert rule takes effect.

05:31-23:59
NoEffectiveInterval

string

No

The time range during which the alert rule is ineffective.

00:00-05:30
SilenceTime

integer

No

The mute period.

Unit: seconds. Default value: 86400.

86400
Period

string

No

The reporting period of monitoring data.

The value of Period must be 60 or a multiple of 60. Unit: seconds. Default value: 300.

60
Interval

string

No

The detection period of the alert rule. Unit: seconds.

Note

Keep the detection period consistent with the data reporting period. If the detection period is shorter than the data reporting period, alerts may not be triggered due to insufficient data.

60
Webhook

string

No

The callback URL to which a request is sent when an alert is triggered.

Enter a publicly accessible URL. CloudMonitor sends a POST request to push alert information to this URL. Only the HTTP protocol is supported.

https://www.aliyun.com
EmailSubject

string

No

The subject of the alert email.

ECS instance
ContactGroups

string

No

The alert contact group.

ECS_Group
Escalations.Critical.Statistics

string

No

Critical 级别报警统计方法。多个统计方法之间用半角逗号（,）分隔。

该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum 和 Average。关于如何获取该参数的取值，请参见云产品监控项。

Average
Escalations.Critical.ComparisonOperator

string

No

Critical 级别阈值比较符。取值：

  • GreaterThanOrEqualToThreshold：大于等于。

  • GreaterThanThreshold：大于。

  • LessThanOrEqualToThreshold：小于等于。

  • LessThanThreshold：小于。

  • NotEqualToThreshold：不等于。

  • GreaterThanYesterday：同比昨天时间上涨。

  • LessThanYesterday：同比昨天时间下降。

  • GreaterThanLastWeek：同比上周同一时间上涨。

  • LessThanLastWeek：同比上周同一时间下降。

  • GreaterThanLastPeriod：环比上周期上涨。

  • LessThanLastPeriod：环比上周期下降。

GreaterThanOrEqualToThreshold
Escalations.Critical.Threshold

string

No

Critical 级别报警阈值。

90
Escalations.Critical.Times

integer

No

Critical 级别报警重试次数。

3
Escalations.Warn.Statistics

string

No

Warn 级别报警统计方法。多个统计方法之间用半角逗号（,）分隔。

该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum 和 Average。关于如何获取该参数的取值，请参见云产品监控项。

Average
Escalations.Warn.ComparisonOperator

string

No

Warn 级别阈值比较符。取值：

  • GreaterThanOrEqualToThreshold：大于等于。

  • GreaterThanThreshold：大于。

  • LessThanOrEqualToThreshold：小于等于。

  • LessThanThreshold：小于。

  • NotEqualToThreshold：不等于。

  • GreaterThanYesterday：同比昨天时间上涨。

  • LessThanYesterday：同比昨天时间下降。

  • GreaterThanLastWeek：同比上周同一时间上涨。

  • LessThanLastWeek：同比上周同一时间下降。

  • GreaterThanLastPeriod：环比上周期上涨。

  • LessThanLastPeriod：环比上周期下降。

GreaterThanOrEqualToThreshold
Escalations.Warn.Threshold

string

No

Warn 级别报警阈值。

90
Escalations.Warn.Times

integer

No

Warn 级别报警重试次数。

3
Escalations.Info.Statistics

string

No

Info 级别报警统计方法。多个统计方法之间用半角逗号（,）分隔。

该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum 和 Average。关于如何获取该参数的取值，请参见云产品监控项。

Average
Escalations.Info.ComparisonOperator

string

No

Info 级别阈值比较符。取值：

  • GreaterThanOrEqualToThreshold：大于等于。

  • GreaterThanThreshold：大于。

  • LessThanOrEqualToThreshold：小于等于。

  • LessThanThreshold：小于。

  • NotEqualToThreshold：不等于。

  • GreaterThanYesterday：同比昨天时间上涨。

  • LessThanYesterday：同比昨天时间下降。

  • GreaterThanLastWeek：同比上周同一时间上涨。

  • LessThanLastWeek：同比上周同一时间下降。

  • GreaterThanLastPeriod：环比上周期上涨。

  • LessThanLastPeriod：环比上周期下降。

GreaterThanOrEqualToThreshold
Escalations.Info.Threshold

string

No

Info 级别报警阈值。

90
Escalations.Info.Times

integer

No

Info 级别报警重试次数。

3
NoDataPolicy

string

No

The processing method when no monitoring data is found. Valid values:

  • KEEP_LAST_STATE (default): No action is performed.

  • INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered.

  • OK: The status is considered normal.

KEEP_LAST_STATE
Labels

array<object>

No

The tags of the alert rule.

Tags are included in alert notifications.

object

No

None.

Key

string

No

The tag key of the alert rule.

key1
Value

string

No

The tag value of the alert rule.

value1
Options

string

No

The advanced settings.

Format: {"key1":"value1","key2":"value2"}. Example: {"NotSendOK":true}. This specifies whether to send a notification when the alert is cleared. The key is NotSendOK, and the value is true (do not send) or false (send, which is the default).

{"NotSendOK":true}

For more information about common request parameters, see Common parameters.

Response elements

Element

Type

Description

Example

object

None.

Code

string

The status code.

Note

A value of 200 indicates success.

200
Message

string

The error message.

The Request is not authorization.
RequestId

string

The request ID.

461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D
Success

boolean

Indicates whether the operation was successful. Valid values:

  • true: The operation was successful.

  • false: The operation failed.

true
Result

object

The result of creating or modifying the alert rule.

RuleId

string

The alert rule ID.

123456

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
  "Success": true,
  "Result": {
    "RuleId": "123456"
  }
}

Error codes

HTTP status code

Error code

Error message

Description
400 %s %s
499 %s %s
500 %s %s
204 %s %s
403 %s %s
206 %s %s
404 %s %s
503 %s %s
406 %s %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.