CreateGroupMonitoringAgentProcess - Cloud Monitor - Alibaba Cloud Documentation Center

Creates a process monitoring task for an application group.

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

create

*GroupMonitoringAgentProcess

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

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the application group. For more information about how to obtain the ID of an application group, see DescribeMonitorGroups.	3607****
ProcessName	string	Yes	The process name.	Process_Java
MatchExpressFilterRelation	string	No	The logical operator used between conditional expressions that are used to match instances. Valid values: all and or	and
MatchExpress	array<object>	No	The expressions used to match instances. Valid values of N: 1 to 3.
	object	No	The expression used to match instances. Valid values of N: 1 to 3.
Value	string	No	The keyword used to match the instance name. Valid values of N: 1 to 3.	portalHost
Name	string	No	The criteria based on which the instances are matched. Valid values of N: 1 to 3. Note Set the value to name. The value name indicates that the instances are matched based on the instance name.	name1
Function	string	No	The matching condition. Valid values: all (default value): matches all startWith: starts with a prefix endWith: ends with a suffix contains: contains notContains: does not contain equals: equals Valid values of N: 1 to 3.	startWith
AlertConfig	array<object>	Yes	The alert rule configurations. Valid values of N: 1 to 3.
	array<object>	No	The alert rule configuration. Valid values of N: 1 to 3.
SilenceTime	string	No	The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day. Valid values of N: 1 to 3. Note Only one alert notification is sent during a mute period even if the metric value exceeds the alert threshold during consecutive checks.	86400
ComparisonOperator	string	Yes	The operator that is used to compare the metric value with the threshold. 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 previous monitoring cycle Valid values of N: 1 to 3.	GreaterThanOrEqualToThreshold
Webhook	string	No	The callback URL. Valid values of N: 1 to 3.	https://www.aliyun.com
Times	string	Yes	The number of times for which the threshold can be consecutively exceeded. Default value: 3. Valid values of N: 1 to 3. Note A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.	3
EscalationsLevel	string	Yes	The alert level. Valid values: critical (default) warn info Valid values of N: 1 to 3.	warn
EffectiveInterval	string	No	The period of time during which the alert rule is effective. Valid values of N: 1 to 3.	07:00-22:59
NoEffectiveInterval	string	No	This parameter is deprecated.	00:00-05:30
Threshold	string	Yes	The alert threshold. Valid values of N: 1 to 3.	5
Statistics	string	Yes	The statistical aggregation method that is used to calculate the metric values. Valid values of N: 1 to 3. Note Set the value to Average.	Average
TargetList	array<object>	No	The alert triggers.
	object	No	The alert trigger.
Id	string	No	The ID of the resource for which alerts are triggered. For more information about how to obtain the ID of a resource for which alerts are triggered, see DescribeMetricRuleTargets.	1
Arn	string	No	The Alibaba Cloud Resource Name (ARN) of the resource. For more information about how to query 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. Set the value to Simple Message Queue (formerly MNS) (SMQ). {userId}: the ID of the Alibaba Cloud account. {regionId}: the region ID of the SMQ queue or topic. {Resource type}: the type of the resource that triggers the alert. Valid values: queues topics {Resource name}: the resource name. If the resource type is queues, the resource name is the queue name. If the resource type is topics**, the resource name is the topic name.	acs:mns:cn-hangzhou:120886317861****:/queues/test/message
Level	string	No	The alert level. Valid values: INFO WARN CRITICAL	["INFO", "WARN", "CRITICAL"]
JsonParams	string	No	The parameters of the alert callback. The parameters are in the JSON format.	{"customField1":"value1","customField2":"$.name"}

Response elements

Element	Type	Description	Example
	object	None.
Code	string	The status code. Note The status code 200 indicates that the call is successful.	200
Message	string	The error message.	The Request is not authorization.
RequestId	string	The request ID.	718FEA81-64C3-4F23-8F90-0531F7489FC1
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
Resource	object	The group process information.
GroupProcessId	string	The ID of the group process.	7F2B0024-4F21-48B9-A764-211CEC48****

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "718FEA81-64C3-4F23-8F90-0531F7489FC1",
  "Success": true,
  "Resource": {
    "GroupProcessId": "7F2B0024-4F21-48B9-A764-211CEC48****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	%s
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.