Queries the process monitoring tasks for an application group.

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeGroupMonitoringAgentProcess

The operation that you want to perform. Set the value to DescribeGroupMonitoringAgentProcess.

GroupId String Yes 12345

The ID of the application group.

ProcessName String No sshd

The name of the process monitoring task.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10.

Response parameters

Parameter Type Example Description
RequestId String 7985D471-3FA8-4EE9-8F4B-45C19DF3D36F

The ID of the request.

Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Success Boolean true

Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.

Processes Array N/A

The process monitoring tasks created for the application group.

Process N/A N/A N/A
AlertConfig Array N/A

The configurations of the alert rule.

AlertConfig N/A N/A N/A
ComparisonOperator String GreaterThanOrEqualToThreshold

The comparison operator of the threshold for critical-level alerts. 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
EffectiveInterval String 00:00-23:59

The time period during which the alert rule is effective.

EscalationsLevel String warn

The level of the alert. Valid values:

  • critical
  • warn
  • info
NoEffectiveInterval String 00:00-23:59

The time period during which the alert rule is ineffective.

SilenceTime String 86400

The duration of the mute period during which new alerts 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 consecutively exceeds the alert threshold several times.
Statistics String Average

The method used to calculate metric values that trigger alerts.

Threshold String 5

The threshold for triggering alerts.

Times String 3

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.
Webhook String http://www.aliyun.com

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

GroupId String 12345

The ID of the application group.

Id String 3F6150F9-45C7-43F9-9578-A58B2E72****

The ID of the process monitoring task.

MatchExpress Array

The conditional expressions used to match the instances.

Note Only the instances that meet the conditional expressions are monitored by the process monitoring task.
MatchExpress
Function String all

The method used to match the instances. Default value: all. Valid values:

  • all
  • startWith
  • endWith
  • contains
  • notContains
  • equals
Note The matched instances are monitored by the process monitoring task.
Name String name

The criteria based on which the instances are matched.

Note Set the value to name, indicating that the instances are matched based on instance name.
Value String portalHost

The keyword used to match the instance name.

MatchExpressFilterRelation String and

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

  • all
  • and
  • or
ProcessName String sshd

The name of the process monitoring task.

Message String The Request is not authorization.

The returned message.

PageNumber String 1

The number of the returned page. Default value: 1.

PageSize String 10

The number of entries returned on each page. Default value: 10.

Total String 28

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeGroupMonitoringAgentProcess
&GroupId=12345
&<Common request parameters>

Sample success responses

XML format

<DescribeGroupMonitoringAgentProcess>
          <RequestId>7985D471-3FA8-4EE9-8F4B-45C19DF3D36F</RequestId>
          <PageSize>10</PageSize>
          <PageNumber>1</PageNumber>
          <Total>28</Total>
          <Processes>
                <Process>
                      <ProcessName>sshd</ProcessName>
                      <MatchExpressFilterRelation>and</MatchExpressFilterRelation>
                      <Id>3F6150F9-45C7-43F9-9578-A58B2E72****</Id>
                      <GroupId>12345</GroupId>
                </Process>
                <Process>
                      <AlertConfig>
                            <AlertConfig>
                                  <Function>all</Function>
                                  <Value>portalHost</Value>
                                  <Name>name</Name>
                            </AlertConfig>
                            <AlertConfig>
                                  <NoEffectiveInterval>00:00-23:59</NoEffectiveInterval>
                                  <SilenceTime>86400</SilenceTime>
                                  <ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>
                                  <Times>3</Times>
                                  <Webhook>http://www.aliyun.com</Webhook>
                                  <EffectiveInterval>00:00-23:59</EffectiveInterval>
                                  <EscalationsLevel>warn</EscalationsLevel>
                                  <Statistics>Average</Statistics>
                                  <Threshold>5</Threshold>
                            </AlertConfig>
                      </AlertConfig>
                      <MatchExpress>
                            <MatchExpress>
                                  <Function>all</Function>
                                  <Value>portalHost</Value>
                                  <Name>name</Name>
                            </MatchExpress>
                            <MatchExpress>
                                  <NoEffectiveInterval>00:00-23:59</NoEffectiveInterval>
                                  <SilenceTime>86400</SilenceTime>
                                  <ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>
                                  <Times>3</Times>
                                  <Webhook>http://www.aliyun.com</Webhook>
                                  <EffectiveInterval>00:00-23:59</EffectiveInterval>
                                  <EscalationsLevel>warn</EscalationsLevel>
                                  <Statistics>Average</Statistics>
                                  <Threshold>5</Threshold>
                            </MatchExpress>
                      </MatchExpress>
                </Process>
          </Processes>
          <Code>200</Code>
          <Success>true</Success>
</DescribeGroupMonitoringAgentProcess>

JSON format

{
    "RequestId":"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F",
    "PageSize":"10",
    "PageNumber":"1",
    "Total":"28",
    "Processes":{
        "Process":[
            {
                "ProcessName":"sshd",
                "MatchExpressFilterRelation":"and",
                "Id":"3F6150F9-45C7-43F9-9578-A58B2E72****",
                "GroupId":"12345"
            },
            {
                "AlertConfig":{
                    "AlertConfig":[
                        {
                            "Function":"all",
                            "Value":"portalHost",
                            "Name":"name"
                        },
                        {
                            "NoEffectiveInterval":"00:00-23:59",
                            "SilenceTime":"86400",
                            "ComparisonOperator":"GreaterThanOrEqualToThreshold",
                            "Times":"3",
                            "Webhook":"http://www.aliyun.com",
                            "EffectiveInterval":"00:00-23:59",
                            "EscalationsLevel":"warn",
                            "Statistics":"Average",
                            "Threshold":"5"
                        }]
                },
                "MatchExpress":{
                    "MatchExpress":[
                        {
                            "Function":"all",
                            "Value":"portalHost",
                            "Name":"name"
                        },
                        {
                            "NoEffectiveInterval":"00:00-23:59",
                            "SilenceTime":"86400",
                            "ComparisonOperator":"GreaterThanOrEqualToThreshold",
                            "Times":"3",
                            "Webhook":"http://www.aliyun.com",
                            "EffectiveInterval":"00:00-23:59",
                            "EscalationsLevel":"warn",
                            "Statistics":"Average",
                            "Threshold":"5"
                        }]
                }
            }]
    },
    "Code":"200",
    "Success":"true"
}

Error codes

For a list of error codes, visit the API Error Center.