DescribeGroupMonitoringAgentProcess - Cloud Monitor - Alibaba Cloud Documentation Center

Queries the process monitoring tasks for an application group.

Operation description

You can create a process monitoring task to monitor all or the specified Elastic Compute Service (ECS) instances in an application group and configure alert rules for the process monitoring task.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the application group.	12345
ProcessName	string	No	The process name.	sshd
PageNumber	integer	No	The page number. Default value: 1	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7985D471-3FA8-4EE9-8F4B-45C19DF3D36F
Success	boolean	Indicates whether the request was successful. Valid values: Valid values: true and false.	true
Code	string	The HTTP status codes. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message.	The Request is not authorization.
PageNumber	string	The page number. Default value: 1	1
PageSize	string	The number of entries per page. Default value: 10.	10
Total	string	The total number of returned entries.	28
Processes	object
Process	array<object>	The process monitoring tasks.
	array<object>	The process monitoring task.
ProcessName	string	The process name.	sshd
MatchExpressFilterRelation	string	The logical operator used between conditional expressions that are used to match instances. Valid values: all and or	and
GroupId	string	The ID of the application group.	12345
Id	string	The ID of the process monitoring task.	3F6150F9-45C7-43F9-9578-A58B2E72****
MatchExpress	object
MatchExpress	array<object>	The matching conditions. Note Only the instances that meet the conditional expressions are monitored by the process monitoring task.
	object
Value	string	The keyword used to match the instance name.	portalHost
Name	string	The criteria based on which the instances are matched. Note Set the value to `name`. The value name indicates that the instances are matched based on the instance name.	name
Function	string	The matching condition. Valid values: all (default): matches all startWith: starts with a prefix endWith: ends with a suffix contains: contains notContains: excludes equals: equals Note The matched instances are monitored by the process monitoring task.	all
AlertConfig	object
AlertConfig	array<object>	The alert rule configurations.
	array<object>	The alert rule configuration.
ComparisonOperator	string	The comparison 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 last monitoring cycle	GreaterThanOrEqualToThreshold
SilenceTime	string	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. Note Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.	86400
Webhook	string	The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.	http://www.aliyun.com
Times	string	The number of times for which the threshold can be consecutively exceeded. Note A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.	3
EscalationsLevel	string	The level of the alert. Valid values: critical warn Info	warn
NoEffectiveInterval	string	The time period during which the alert rule is ineffective.	00:00-23:59
EffectiveInterval	string	The time period during which the alert rule is effective.	00:00-23:59
Threshold	string	The alert threshold.	5
Statistics	string	The method used to calculate metric values that trigger alerts.	Average
TargetList	object
Target	array<object>	The resources for which alerts are triggered.
	object	The resource for which alerts are triggered.
Id	string	The ID of the resource for which alerts are triggered.	123
Arn	string	The Alibaba Cloud Resource Name (ARN) of the resource. 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 for which alerts are triggered. 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	The alert level. Valid values: INFO WARN CRITICAL	CRITICAL
JsonParmas	string	The parameters of the alert callback. The parameters are in the JSON format.	{"customField1":"value1","customField2":"$.name"}

Examples

Success response

JSON format

{
  "RequestId": "7985D471-3FA8-4EE9-8F4B-45C19DF3D36F",
  "Success": true,
  "Code": "200",
  "Message": "The Request is not authorization.",
  "PageNumber": "1",
  "PageSize": "10",
  "Total": "28",
  "Processes": {
    "Process": [
      {
        "ProcessName": "sshd",
        "MatchExpressFilterRelation": "and",
        "GroupId": "12345",
        "Id": "3F6150F9-45C7-43F9-9578-A58B2E72****",
        "MatchExpress": {
          "MatchExpress": [
            {
              "Value": "portalHost",
              "Name": "name",
              "Function": "all"
            }
          ]
        },
        "AlertConfig": {
          "AlertConfig": [
            {
              "ComparisonOperator": "GreaterThanOrEqualToThreshold",
              "SilenceTime": "86400",
              "Webhook": "http://www.aliyun.com",
              "Times": "3",
              "EscalationsLevel": "warn",
              "NoEffectiveInterval": "00:00-23:59",
              "EffectiveInterval": "00:00-23:59",
              "Threshold": "5",
              "Statistics": "Average",
              "TargetList": {
                "Target": [
                  {
                    "Id": "123",
                    "Arn": "acs:mns:cn-hangzhou:120886317861****:/queues/test/message",
                    "Level": "CRITICAL",
                    "JsonParmas": "{\"customField1\":\"value1\",\"customField2\":\"$.name\"}"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.
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.