All Products
Search

This Product

    CloudMonitor:PutCustomMetricRule

    Document Center

    CloudMonitor:PutCustomMetricRule

    Last Updated:Jul 26, 2024

    Operation description

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

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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:
      • The required resource types are displayed in bold characters.
      • 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 name of the metric.

    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 group that receives alert notifications. Separate multiple alert 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 time period during which the alert rule is effective. Valid values: 00:00 to 23:59.

    		00:00-23:59
    SilenceTimeintegerNo

    The mute period during which notifications are not repeatedly sent for an alert. Unit: seconds. Default value: 86400. The default value indicates one day.

    Note Only one alert notification is sent during each mute period even if the metric value consecutively 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 threshold of the metric value.

    		90
    LevelstringYes

    The level of the alert. Valid values:

    • CRITICAL
    • WARN
    • INFO
    		CRITICAL
    EvaluationCountintegerYes

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

    		3
    StatisticsstringYes

    The method that is used to calculate the metric values that trigger alerts.

    		Average
    ComparisonOperatorstringYes

    The comparison operator before the threshold. Valid values:

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

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The HTTP status code.

    Note The value 200 indicates that the call was successful.
    		200
    Messagestring

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

    		ComparisonOperator is mandatory for this action.
    RequestIdstring

    The ID of the request.

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

    Indicates whether the call was successful. Valid values:

    • true: The call was successful.
    • false: The call failed.
    		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