文档

PutMetricRuleTargets - 为指定报警规则添加或修改推送渠道

更新时间:

调用PutMetricRuleTargets接口为指定报警规则添加或修改推送渠道。

接口说明

使用说明

本文将提供一个示例,为报警规则ae06917_75a8c43178ab66****关联资源acs:mns:cn-hangzhou:120886317861****:/queues/test/message,报警触发目标 ID 为1。返回结果显示,添加关联资源成功。

调试

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

授权信息

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

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

请求参数

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

报警规则 ID。

关于如何获取报警规则 ID,请参见 DescribeMetricRuleList

ae06917_75a8c43178ab66****
Targetsarray<object>

无。

object

无。

Idstring

报警触发目标 ID。

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

1
Arnstring

资源 ARN。目前支持消息服务 MNS,弹性伸缩 ESS,日志服务 SLS,函数计算 FC。

消息服务的 ARN 参数说明如下:

acs:mns:{regionId}:{userId}:/{资源类型}/{资源名称}/message

  • {regionId}:消息队列或主题所在地域。

  • {userId}:资源所属的阿里云账号。

  • {资源类型}`:接收报警的资源类型。取值:

    • queues:队列。
    • topics:主题。
  • {资源名称}:资源名称。

    • 如果资源类型为 queues,则资源名称为队列名称。
    • 如果资源类型为 topics,则资源名称为主题名称。

弹性伸缩的 ARN:

acs:ess:{regionId}:{userId}:scalingGroupId/{伸缩组 id}:scalingRuleId/{伸缩规则 id}

日志服务的 ARN:

acs:log:{regionId}:{userId}:project/{project 名称}/logstore/{日志库名称}

函数计算的 ARN:

acs:fc:{regionId}:{userId}:services/{服务名称}/functions/{函数名称}

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 processing has failed due to some unknown error.
RequestIdstring

请求 ID。

6A569B0D-9055-58AF-9E82-BAEAF95C0FD5
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
FailDataobject

失败列表。

Targetsarray<object>

报警触发目标。

object

无。

Idstring

报警触发目标 ID。

1
Arnstring

资源 ARN。格式为acs:{云产品缩写}:{regionId}:{userId}:/{资源类型}/{资源名称}/message。目前支持消息服务 MNS,弹性伸缩 ESS,日志服务 SLS,函数计算 FC。例如:acs:mns:cn-hangzhou:120886317861****:/queues/test123/message。消息服务的 ARN 参数说明如下:

  • {云产品缩写}:mns

  • {userId}:阿里云账号 ID。

  • {regionId}:消息队列或主题所在地域。

  • {资源类型}`:接收报警的资源类型。取值:

    • queues:队列。
    • topics:主题。
  • {资源名称}:资源名称。

    • 如果资源类型为 queues,则资源名称为队列名称。
    • 如果资源类型为 topics,则资源名称为主题名称。
acs:mns:cn-hangzhou:111:/queues/test/message
Levelstring

报警级别。取值:

  • INFO:信息。
  • WARN:警告。
  • CRITICAL:紧急。
["INFO", "WARN", "CRITICAL"]

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The request processing has failed due to some unknown error.",
  "RequestId": "6A569B0D-9055-58AF-9E82-BAEAF95C0FD5",
  "Success": true,
  "FailData": {
    "Targets": {
      "Target": [
        {
          "Id": "1",
          "Arn": "acs:mns:cn-hangzhou:111:/queues/test/message",
          "Level": "[\"INFO\", \"WARN\", \"CRITICAL\"]"
        }
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息
200%s%s
500InternalErrorThe request processing has failed due to some unknown error.

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

变更历史

变更时间变更内容概要操作
2022-03-21OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情