DocsICP FilingConsole
官方文档
首页

PutCustomMetricRule

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

Creates a custom monitoring alert rule by calling the PutCustomMetricRule operation.

Operation description

调用本接口前，请先调用 PutCustomMetric 接口上报自定义监控数据，详情请参见 PutCustomMetric 。

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:PutCustomMetricRule

create

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
GroupId

string

No

The ID of the application group to which the custom monitoring data belongs.

Note

A value of 0 indicates that the reported custom monitoring data does not belong to any application group.

7378****
RuleId

string

Yes

The ID of the alert rule.

Note

If the alert rule ID already exists, the alert rule is modified. If the alert rule ID does not exist, an alert rule is created.

MyRuleId1
RuleName

string

No

The name of the alert rule.

CpuUsage
MetricName

string

Yes

The metric name.

Note

For more information about how to obtain the metric name, see DescribeCustomMetricList.

cpu_total
Resources

string

Yes

The custom monitoring data to which the alert rule applies. The value consists of the application group ID to which the custom monitoring data belongs and the dimensions of the metric.

[{"groupId":7378****,"dimension":"instanceId=i-hp3543t5e4sudb3s****"}]
ContactGroups

string

Yes

The alert contact group. Separate multiple alert contact groups with commas (,).

ECS_Group
Webhook

string

No

The alert callback URL. An HTTP POST request is sent to the specified URL when an alert is triggered.

https://www.aliyun.com
EffectiveInterval

string

No

The effective time range of the alert rule. Valid values: 00:00-23:59.

00:00-23:59
SilenceTime

integer

No

The mute for period. Unit: seconds. Default value: 86400 (1 day).

Note

If the monitoring data continuously exceeds the alert threshold, only one alert notification is sent within each mute for period.

86400
Period

string

No

The aggregation period of the custom monitoring data. Unit: seconds. Set the value to 60 or a multiple of 60. Default value: the original reporting period of the custom monitoring data.

300
EmailSubject

string

No

The subject of the alert email.

ECS instance
Threshold

string

Yes

The alert threshold.

90
Level

string

Yes

The alert level. Valid values:

  • CRITICAL: critical.

  • WARN: warning.

  • INFO: information.

CRITICAL
EvaluationCount

integer

Yes

The number of alert retries.

3
Statistics

string

Yes

The statistical method for alerts.

Average
ComparisonOperator

string

Yes

The comparison operator for the threshold. Valid values:

  • >=

  • =

  • <=

  • >

  • <

  • !=.

>=

Response elements

Element

Type

Description

Example

object

Code

string

状态码。

Note

200 表示成功。

200
Message

string

返回信息。接口调用成功时，返回为空；接口调用失败时，返回失败原因。

ComparisonOperator is mandatory for this action.
RequestId

string

请求 ID。

65D50468-ECEF-48F1-A6E1-D952E89D9432
Success

boolean

操作是否成功。取值：

  • true：成功。

  • false：失败。

true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "ComparisonOperator is mandatory for this action.",
  "RequestId": "65D50468-ECEF-48F1-A6E1-D952E89D9432",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description
400 %s %s
499 %s %s
500 InternalError The request processing has failed due to some unknown error.
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.