All Products
Search
Document Center

CloudMonitor:DescribeGroupMonitoringAgentProcess

Last Updated:Jul 26, 2024

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.

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:DescribeGroupMonitoringAgentProcessget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringYes

The ID of the application group.

12345
ProcessNamestringNo

The process name.

sshd
PageNumberintegerNo

The page number. Default value: 1

1
PageSizeintegerNo

The number of entries per page. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID.

7985D471-3FA8-4EE9-8F4B-45C19DF3D36F
Successboolean

Indicates whether the request was successful. Valid values: Valid values: true and false.

true
Codestring

The HTTP status codes.

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

The error message.

The Request is not authorization.
PageNumberstring

The page number. Default value: 1

1
PageSizestring

The number of entries per page. Default value: 10.

10
Totalstring

The total number of returned entries.

28
Processesarray<object>

The process monitoring tasks.

object
ProcessNamestring

The process name.

sshd
MatchExpressFilterRelationstring

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

  • all
  • and
  • or
and
GroupIdstring

The ID of the application group.

12345
Idstring

The ID of the process monitoring task.

3F6150F9-45C7-43F9-9578-A58B2E72****
MatchExpressarray<object>

The matching conditions.

Note Only the instances that meet the conditional expressions are monitored by the process monitoring task.
object
Valuestring

The keyword used to match the instance name.

portalHost
Namestring

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
Functionstring

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
AlertConfigarray<object>

The alert rule configurations.

object
ComparisonOperatorstring

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
SilenceTimestring

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
Webhookstring

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

http://www.aliyun.com
Timesstring

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
EscalationsLevelstring

The level of the alert. Valid values:

  • critical
  • warn
  • Info
warn
NoEffectiveIntervalstring

The time period during which the alert rule is ineffective.

00:00-23:59
EffectiveIntervalstring

The time period during which the alert rule is effective.

00:00-23:59
Thresholdstring

The alert threshold.

5
Statisticsstring

The method used to calculate metric values that trigger alerts.

Average
TargetListarray<object>

The resource for which alerts are triggered.

object
Idstring

The ID of the resource for which alerts are triggered.

123
Arnstring

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. 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 that triggers the alert. Valid values: - queues - topics - {Resource name}: the resource name. - 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
Levelstring

The level of the alert. Valid values:

INFO WARN CRITICAL

CRITICAL
JsonParmasstring

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

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

Examples

Sample success responses

JSONformat

{
  "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 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
No change history