文档

DescribeMetricRuleTargets - 查询指定报警规则的推送渠道

更新时间:

调用DescribeMetricRuleTargets接口查询指定报警规则的推送渠道。

接口说明

使用说明

本文将提供一个示例,查询报警规则ae06917_75a8c43178ab66****关联的目标资源。

调试

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

授权信息

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

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

请求参数

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

报警规则 ID。

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

ae06917_75a8c43178ab66****

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

User not authorized to operate on the specified resource.
RequestIdstring

请求 ID。

786E92D2-AC66-4250-B76F-F1E2FCDDBA1C
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Targetsobject []

报警触发目标。

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:120886317861****:/queues/test/message
Levelstring

报警级别。取值:

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

报警回调的 JSON 格式参数。

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

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "786E92D2-AC66-4250-B76F-F1E2FCDDBA1C",
  "Success": true,
  "Targets": {
    "Target": [
      {
        "Id": "1",
        "Arn": "acs:mns:cn-hangzhou:120886317861****:/queues/test/message",
        "Level": "INFO",
        "JsonParams": "{\"customField1\":\"value1\",\"customField2\":\"$.name\"}"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400InvalidParameterValue%s
400%s%s
403AccessForbiddenUser not authorized to operate on the specified resource.
500InternalError%s
500InternalErrorThe request processing has failed due to some unknown error.

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

变更历史

变更时间变更内容概要操作
2023-07-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:500
2022-03-21OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:500
出参OpenAPI 返回结构发生变更