文档

CreateGroupMonitoringAgentProcess - 创建组进程监控

更新时间:

调用CreateGroupMonitoringAgentProcess接口创建组进程监控。

调试

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

授权信息

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

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

请求参数

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

应用分组 ID。

关于如何获取应用分组 ID,请参见 DescribeMonitorGroups

3607****
ProcessNamestring

进程名称。

Process_Java
MatchExpressFilterRelationstring

匹配实例的条件。取值:

  • all:全部。
  • and:与。
  • or:或。
and
MatchExpressobject []

匹配条件表达式列表。

N 的取值范围:1~3。

Valuestring

匹配实例名称。

N 的取值范围:1~3。

portalHost
Namestring

匹配条件的类型。

N 的取值范围:1~3。

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

匹配条件。取值:

  • all(默认值):全部。
  • startWith:前缀。
  • endWith:后缀。
  • contains:包含。
  • notContains:不包含。
  • equals:相等。

N 的取值范围:1~3。

startWith
AlertConfigobject []

报警规则配置列表。

N 的取值范围:1~3。

SilenceTimestring

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

N 的取值范围:1~3。

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

阈值比较符。取值:

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

N 的取值范围:1~3。

GreaterThanOrEqualToThreshold
Webhookstring

报警回调 URL 地址。

N 的取值范围:1~3。

https://www.aliyun.com
Timesstring

报警级别连续出现次数。默认:3 次。

N 的取值范围:1~3。

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

报警级别。取值:

  • critical(默认值):故障。
  • warn:警告。
  • info:信息。

N 的取值范围:1~3。

warn
EffectiveIntervalstring

报警规则的生效时间段。

N 的取值范围:1~3。

07:00-22:59
NoEffectiveIntervalstring

该参数已废弃,无需关注。

Thresholdstring

报警阈值。

N 的取值范围:1~3。

单位:个。

5
Statisticsstring

报警统计方式。

N 的取值范围:1~3。

说明 目前仅支持 Average。
Average
TargetListobject []

报警触发列表。

Idstring

报警触发目标 ID。

关于如何获取报警触发目标 ID,请参见 DescribeMetricRuleTargets

1
Arnstring

资源 ARN。

关于如何获取资源 ARN,请参见 DescribeMetricRuleTargets

资源 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:紧急。
["INFO", "WARN", "CRITICAL"]
JsonParamsstring

报警回调的 JSON 格式参数。

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

返回参数

名称类型描述示例值
object

无。

Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
RequestIdstring

请求 ID。

718FEA81-64C3-4F23-8F90-0531F7489FC1
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Resourceobject

组进程信息。

GroupProcessIdstring

组进程 ID。

7F2B0024-4F21-48B9-A764-211CEC48****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400ParameterInvalid%s-
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.-

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

变更历史

变更时间变更内容概要操作
2023-03-20OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2022-08-05OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500