All Products
Search
Document Center

CloudMonitor:ModifyGroupMonitoringAgentProcess

Last Updated:Jul 26, 2024

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:ModifyGroupMonitoringAgentProcessupdate
  • MonitoringAgentProcess
    acs:cms::{#accountId}:group/{#groupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdstringYes

The ID of the process monitoring task.

92E3065F-0980-4E31-9AA0-BA6****
GroupIdstringYes

The ID of the application group.

6780****
MatchExpressFilterRelationstringNo

The logical operator used between conditional expressions that are used to match instances. Valid values:

  • all
  • and
  • or
and
AlertConfigarray<object>Yes

The alert rule configurations.

objectYes

The alert rule configurations.

SilenceTimestringNo

The mute period during which new alerts are not sent even if the trigger conditions are met. Valid values of N: 1 to 200.

Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.

Note Only one alert notification is sent during a mute period even if the metric value exceeds the alert threshold during consecutive checks.
86400
ComparisonOperatorstringYes

The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid values:

  • GreaterThanOrEqualToThreshold: greater than or equal to the threshold
  • GreaterThanThreshold: greater than the threshold
  • LessThanOrEqualToThreshold: less than or equal to the threshold
  • LessThanThreshold: less than the threshold.
  • NotEqualToThreshold: not equal to the threshold
  • GreaterThanYesterday: greater than the metric value at the same time yesterday.
  • LessThanYesterday: less than the metric value at the same time yesterday
  • GreaterThanLastWeek: greater than the metric value at the same time last week
  • LessThanLastWeek: less than the metric value at the same time last week
  • GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle
  • LessThanLastPeriod: less than the metric value in the last monitoring cycle
GreaterThanOrEqualToThreshold
WebhookstringNo

The callback URL to which a POST request is sent when an alert is triggered based on the alert rule. Valid values of N: 1 to 200.

http://www.aliyun.com
TimesstringYes

The number of times for which the threshold can be consecutively exceeded. Valid values of N: 1 to 200. Default value: 3.

Note A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.
3
EscalationsLevelstringYes

The level of the alert. Valid values of N: 1 to 200. Valid values:

  • critical (default value): critical
  • warn: warning
  • info: information
warn
EffectiveIntervalstringNo

The time period during which the alert rule is effective. Valid values of N: 1 to 200.

00:00-22:59
NoEffectiveIntervalstringNo

The time period during which the alert rule is ineffective. Valid values of N: 1 to 200.

23:00-23:59
ThresholdstringYes

The alert threshold. Valid values of N: 1 to 200.

5
StatisticsstringNo

The statistical aggregation method that is used to calculate the metric values. Valid values of N: 1 to 200.

Note Set the value to Average.
Average
TargetListarray<object>No

The alert trigger.

objectNo

The alert trigger.

IdstringNo

The ID of the resource for which alerts are triggered.

For information about how to obtain the ID of a resource for which alerts are triggered, see DescribeMetricRuleTargets .

1
ArnstringNo

The Alibaba Cloud Resource Name (ARN) of the resource.

For information about how to obtain the ARN of a resource, see DescribeMetricRuleTargets .

Format: acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message. Example: acs:mns:cn-hangzhou:120886317861****:/queues/test123/message. Fields:

  • {Service name abbreviation}: the abbreviation of the service name. Valid value: mns.
  • {userId}: the ID of the Alibaba Cloud account.
  • {regionId}: the region ID of the message queue or topic.
  • {Resource type}: the type of the resource for which alerts are triggered. Valid values:
    • queues
    • topics
  • {Resourcename}: the name of the resource.
    • If the resource type is set to queues, the resource name is the name of the message queue.
    • If the resource type is set to topics, the resource name is the name of the topic.`
acs:mns:cn-hangzhou:120886317861****:/queues/test/message
LevelstringNo

The level of the alert. Valid values:

  • INFO: information
  • WARN: warning
  • CRITICAL: critical
["INFO", "WARN", "CRITICAL"]
JsonParamsstringNo

The parameters of the alert callback. The parameters are in the JSON format.

{"customField1":"value1","customField2":"$.name"}

Response parameters

ParameterTypeDescriptionExample
object

N/A.

Codestring

The HTTP status code.

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

The error message.

The Request is not authorization.
RequestIdstring

The ID of the request.

7985D471-3FA8-4EE9-8F4B-45C19DF3D36F
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": "The Request is not authorization.",
  "RequestId": "7985D471-3FA8-4EE9-8F4B-45C19DF3D36F",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.The specified resource is not found.
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
2022-08-05The Error code has changedView Change Details