文档

PutEventRuleTargets - 添加或修改规则的推送渠道

更新时间:

调用PutEventRuleTargets接口添加或修改规则的推送渠道。

调试

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

授权信息

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

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

请求参数

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

报警规则的名称。

testEventRule
FcParametersobject []

函数计算通知方式。

FunctionNamestring

函数名称。N 的取值范围:1~5。

fc-test
Regionstring

函数服务对应的地域。N 的取值范围:1~5。

cn-hangzhou
ServiceNamestring

函数服务的服务名称。N 的取值范围为 1~5。

fc-test
Idstring

规则发送目标的唯一标识。N 的取值范围:1~5。

1
ContactParametersobject []

报警联系组通知方式。

ContactGroupNamestring

报警联系人组的名称。N 的取值范围:1~5。

默认报警联系组
Idstring

规则发送目标的唯一标识。N 的取值范围:1~5。

2
Levelstring

报警通知级别。N 的取值范围:1~5。取值:

  • 2:电话、短信、钉钉、邮箱

  • 3:短信、钉钉、邮箱

  • 4:钉钉、邮箱

4
MnsParametersobject []

消息服务通知。

Regionstring

消息服务对应的地域。N 的取值范围:1~5。

cn-hangzhou
Queuestring

队列名称。N 的取值范围:1~5。

queue1
Idstring

规则发送目标的唯一标识。N 的取值范围:1~5。

3
Topicstring

消息服务的主题。

topic_sample
WebhookParametersobject []

URL 回调通知方式。

Protocolstring

协议名称。N 的取值范围:1~5。取值:

  • http
  • telnet
  • ping
http
Urlstring

回调的 URL。N 的取值范围:1~5。

http://www.aliyun.com
Methodstring

HTTP 回调的请求方法。N 的取值范围:1~5。

目前仅支持 GET 和 POST。

GET
Idstring

规则发送目标的唯一标识。N 的取值范围:1~5。

4
SlsParametersobject []

日志服务(SLS)通知方式。

LogStorestring

日志服务对应的日志库。N 的取值范围:1~5。

testlogstore
Regionstring

日志服务对应的地域。N 的取值范围:1~5。

cn-hangzhou
Projectstring

日志服务对应的项目。N 的取值范围:1~5。

testproject
Idstring

规则发送目标的唯一标识。N 的取值范围:1~5。

5
OpenApiParametersobject []

API 回调通知参数列表。

Actionstring

API 名称。

PutLogs
Arnstring

资源的 ARN。N 的取值范围:1~5。 格式:arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}。各字段含义如下:

  • Service:云产品。
  • Region:地域 ID。
  • Account:阿里云账号 ID。
  • ResourceType:资源类型。
  • ResourceId:资源 ID。
acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***
Idstring

API 回调通知方式的唯一标识。

3
Productstring

API 对应的云产品 ID。

log
Regionstring

资源对应的地域。

cn-hangzhou
Rolestring

角色名称。

MyRole
Versionstring

API 的版本。

2019-01-01
JsonParamsstring

报警回调的 JSON 格式参数。

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

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
RequestIdstring

请求 ID。

409C64DA-CF14-45DF-B463-471C790DD15A
Successboolean

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

true
FailedParameterCountstring

错误参数数量统计。

2
FailedContactParametersobject []

如果规则发送目标中包含创建错误的报警联系人组,则返回此参数。

ContactGroupNamestring

报警联系人组的名称。

默认报警联系人组
Idinteger

规则发送目标的 ID。

2
Levelstring

报警通知级别。取值:

  • 2:电话、短信、钉钉、邮箱

  • 3:短信、钉钉、邮箱

  • 4:钉钉、邮箱

4
FailedMnsParametersobject []

如果规则发送目标中包含创建错误的消息服务,则返回此参数。

Queuestring

队列的名称。

testQueue
Idinteger

规则发送目标的 ID。

2
Regionstring

地域 ID。

cn-hangzhou
FailedFcParametersobject []

如果规则发送目标中包含创建错误的函数服务,则返回此参数。

ServiceNamestring

函数服务的名称。

serviceTest1
FunctionNamestring

函数名称。

functionTest1
Idinteger

规则发送目标的 ID。

1
Regionstring

地域 ID。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "409C64DA-CF14-45DF-B463-471C790DD15A",
  "Success": true,
  "FailedParameterCount": "2",
  "FailedContactParameters": {
    "ContactParameter": [
      {
        "ContactGroupName": "默认报警联系人组",
        "Id": 2,
        "Level": "4"
      }
    ]
  },
  "FailedMnsParameters": {
    "MnsParameter": [
      {
        "Queue": "testQueue",
        "Id": 2,
        "Region": "cn-hangzhou"
      }
    ]
  },
  "FailedFcParameters": {
    "FcParameter": [
      {
        "ServiceName": "serviceTest1",
        "FunctionName": "functionTest1",
        "Id": 1,
        "Region": "cn-hangzhou"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2021-12-22OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500