All Products
Search

This Product

    Cloud Monitor:PutCustomMetricRule

    Document Center

    Cloud Monitor:PutCustomMetricRule

    Last Updated:Oct 29, 2025

    Creates a custom alert rule.

    Operation description

    Before you call this operation, call the PutCustomMetric operation to report custom monitoring data. For more information, see PutCustomMetric .

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    cms:PutCustomMetricRulecreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    GroupIdstringNo

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

    Note The value 0 indicates that the reported custom monitoring data does not belong to an application group.
    		7378****
    RuleIdstringYes

    The ID of the alert rule.

    Note You can specify an existing ID to modify the corresponding alert rule or specify a new ID to create an alert rule.
    		MyRuleId1
    RuleNamestringNo

    The name of the alert rule.

    		CpuUsage
    MetricNamestringYes

    The metric name.

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

    The custom monitoring data to which the alert rule applies. The value includes the application group ID to which the custom monitoring data belongs and the dimension to which the metric belongs.

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

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

    		ECS_Group
    WebhookstringNo

    The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.

    		https://www.aliyun.com
    EffectiveIntervalstringNo

    The period of time during which the alert rule is effective. Valid values: 00:00 to 23:59.

    		00:00-23:59
    SilenceTimeintegerNo

    The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400, which is equivalent to one day.

    Note Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.
    		86400
    PeriodstringNo

    The cycle that is used to aggregate custom monitoring data. Unit: seconds Set the value to an integral multiple of 60. The original reporting cycle of custom monitoring data is used by default.

    		300
    EmailSubjectstringNo

    The subject of the alert notification email.

    ThresholdstringYes

    The alert threshold.

    		90
    LevelstringYes

    The alert level. Valid values:

    • CRITICAL
    • WARN
    • INFO
    		CRITICAL
    EvaluationCountintegerYes

    The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.

    		3
    StatisticsstringYes

    The method used to calculate the metric value based on which alerts are triggered.

    		Average
    ComparisonOperatorstringYes

    The operator that is used to compare the metric value with the threshold. Valid values:

    • >=
    • =
    • <=
    • >
    • <
    • !=
    		>=

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The status code.

    Note The status code 200 indicates that the request was successful.
    		200
    Messagestring

    The returned message. If the request was successful, the return value is null. If the request failed, an error message is returned.

    		ComparisonOperator is mandatory for this action.
    RequestIdstring

    The request ID.

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

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    403%s%s
    500InternalErrorThe request processing has failed due to some unknown error.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history