文档

DescribeGroupMonitoringAgentProcess - 获取组进程监控任务列表

更新时间:

调用DescribeGroupMonitoringAgentProcess接口获取组进程监控任务列表。

接口说明

组进程监控用于为组内的所有 ECS 实例或满足条件的 ECS 实例同时添加一个进程监控并设置报警规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:DescribeGroupMonitoringAgentProcessRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
GroupIdstring

应用分组 ID。

12345
ProcessNamestring

进程名称。

sshd
PageNumberinteger

分页页码。默认值:1。

1
PageSizeinteger

分页大小。默认值:10。

10

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

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

操作是否成功。true 表示成功,false 表示失败。

true
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
PageNumberstring

分页码。默认值:1。

1
PageSizestring

每页显示记录条数。默认值:10。

10
Totalstring

总记录条数。

28
Processesobject []

进程任务列表。

ProcessNamestring

进程名称。

sshd
MatchExpressFilterRelationstring

匹配实例的条件。取值:

  • all:全部。
  • and:与。
  • or:或。
and
GroupIdstring

应用分组的 ID。

12345
Idstring

进程任务的 ID。

3F6150F9-45C7-43F9-9578-A58B2E72****
MatchExpressobject []

匹配条件。

说明 只有符合匹配条件的应用分组,实例才能被添加到对应的进程中。
Valuestring

匹配实例名称。

portalHost
Namestring

匹配条件的类型。

说明 目前仅支持name,即实例名称。
name
Functionstring

匹配条件。取值:

  • all(默认值):全部。
  • startWith:前缀。
  • endWith:后缀。
  • contains:包含。
  • notContains:不包含。
  • equals:相等。
说明 对于满足条件的规则,实例会添加对应的进程监控。
all
AlertConfigobject []

报警规则配置信息。

ComparisonOperatorstring

Critical 级别阈值比较符。取值:

  • GreaterThanOrEqualToThreshold:大于等于。
  • GreaterThanThreshold:大于。
  • LessThanOrEqualToThreshold:小于等于。
  • LessThanThreshold:小于。
  • NotEqualToThreshold:不等。
  • GreaterThanYesterday:同比昨天时间上涨。
  • LessThanYesterday:同比昨天时间下降。
  • GreaterThanLastWeek:同比上周同一时间上涨。
  • LessThanLastWeek:同比上周同一时间下降。
  • GreaterThanLastPeriod:环比上周期上涨。
  • LessThanLastPeriod:环比上周期下降。
GreaterThanOrEqualToThreshold
SilenceTimestring

通道沉默周期。单位:秒。最短:3600 秒(1 小时),默认值:86400 秒(1 天)。

说明 当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。
86400
Webhookstring

报警发生时回调指定的 URL 地址,向 URL 发送 POST 请求。

http://www.aliyun.com
Timesstring

级别连续出现次数。

说明 只有当级别连续出现设定的次数且超过阈值时,才会触发报警。
3
EscalationsLevelstring

报警的级别。取值:

  • critical:故障。
  • warn:警告。
  • info:信息。
warn
NoEffectiveIntervalstring

报警规则不生效时间段。

00:00-23:59
EffectiveIntervalstring

报警规则的生效时间段。

00:00-23:59
Thresholdstring

报警阈值。

5
Statisticsstring

报警统计方法。

Average
TargetListobject []

报警触发目标列表。

Idstring

报警触发目标 ID。

123
Arnstring

资源 ARN。格式为 acs:{云产品缩写}:{regionId}:{userId}:/{资源类型}/{资源名称}/message。例如:acs:mns:cn-hangzhou:120886317861****:/queues/test123/message。参数说明如下:

  • {云产品缩写}:目前仅支持消息服务 MNS。
  • {userId}:阿里云账号 ID。
  • {regionId}:消息队列或主题所在地域。
  • {资源类型}:接收报警的资源类型。取值:
    • queues:队列。
    • topics:主题。
  • {资源名称}:资源名称。
    • 如果资源类型为 queues,则资源名称为队列名称。
    • 如果资源类型为 topics,则资源名称为主题名称。
acs:mns:cn-hangzhou:120886317861****:/queues/test/message
Levelstring

报警级别。取值:

  • INFO:信息。
  • WARN:警告。
  • CRITICAL:紧急。
CRITICAL
JsonParmasstring

报警回调的 JSON 格式参数。

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

示例

正常返回示例

JSON格式

{
  "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\"}"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
500InternalErrorThe request processing has failed due to some unknown error.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史