调用PutTargets在指定的规则下创建或更新事件目标_事件总线(EventBridge)-阿里云帮助中心

在指定的规则下创建或更新事件目标。

接口说明

在指定的规则下创建或更新事件目标。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
eventbridge:PutTargets	Write	Rule acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/rule/{#RuleName}	无	无

请求参数

名称	类型	必填	描述	示例值
EventBusName	string	是	事件总线的名称。	eventTest
RuleName	string	是	事件规则的名称。	ssr-send-to-vendor-test01
Targets	object []	是	需要新增或更新的事件目标列表。更多信息，请参见使用限制。
Id	string	是	自定义事件目标 Id。	Mlm123456JHd2RsRoKw
Type	string	是	事件目标类型。更多信息，请参见事件目标参数。	acs.fc.function
Endpoint	string	否	投递端点链接。	acs:fc:cn-hangzhou:123456789098****:services/guide.LATEST/functions/HelloFC
PushRetryStrategy	string	否	推送重试策略。取值说明如下： BACKOFF_RETRY：退避重试策略。重试 3 次，每次重试的间隔时间是 10 秒到 20 秒之间的随机值。 EXPONENTIAL_DECAY_RETRY：指数衰减重试。重试 176 次，每次重试的间隔时间指数递增至 512 秒，总计重试时间为 1 天；每次重试的具体间隔为：1，2，4，8，16，32，64，128，256，512，512...512 秒（共 167 个 512）。	BACKOFFRETRY
DeadLetterQueue	object	否	死信队列。未处理或者超过重试次数的事件会被写入死信队列。当前死信队列支持的队列类型有消息队列 RocketMQ 版、消息服务 MNS、消息队列 Kafka 版和 EventBridge 事件总线。
Arn	string	否	死信队列的 Arn，未处理或超过重试次数的事件会被写入死信队列。	acs:mns:cn-hangzhou:123456789098**:/queues/deadletterqueue 或 acs:mq:cn-hangzhou:123456789098:/instances/MQ_INST_123456789098_BX8QbBPL/topic/deadlettertopic 或 acs:alikafka:cn-hangzhou:123456789098:instance/alikafka_post-cn-123456/topic/deadlettertopic 或 acs:eventbridge:cn-hangzhou:123456789098**:eventbus/deadletterbus
ErrorsTolerance	string	否	容错策略。取值说明如下： ALL：允许容错。允许异常容错，当异常发生时不会阻塞执行，超过重试策略后会根据配置将消息投递至死信队列或直接丢弃。 NONE：禁止容错。不允许容错，当异常发生并超过重试策略配置时会阻塞执行。	ALL
ParamList	object []	否	事件目标的参数。
ResourceKey	string	否	事件目标的资源参数。更多信息，请参见事件目标参数。	body
Form	string	否	事件目标参数的格式。更多信息，请参见事件目标参数。	TEMPLATE
Value	string	否	事件目标参数的值。	{\"key\"=\"value\"}
Template	string	否	事件目标参数模板样式。	The value of ${key} is ${value}!

返回参数

名称	类型	描述	示例值
	object
Message	string	错误信息。	The event rule not existed!
RequestId	string	阿里云为该请求生成的唯一标识符。	6FB52207-7621-5292-BDF2-A17E2E984160
Data	object	返回结果。
ErrorEntriesCount	integer	处理失败的事件目标数量。取值说明如下：取值为 0：所有事件目标均正常处理。取值为除 0 以外的其他整数：处理失败的事件目标个数。	0
ErrorEntries	object []	处理失败的事件目标信息。
ErrorMessage	string	错误详细描述。	The id of event target is duplicate!
ErrorCode	string	错误码。	EventRuleTargetIdDuplicate
EntryId	string	处理失败的事件目标 Id。	Mlm123456JHd2RsRoKw
Code	string	接口返回码： Success：表示成功。其它：表示错误码。错误码详情，请参见错误码。	Success
Success	boolean	操作成功返回 true。	true

示例

正常返回示例

JSON格式

{
  "Message": "The event rule not existed!",
  "RequestId": "6FB52207-7621-5292-BDF2-A17E2E984160\n",
  "Data": {
    "ErrorEntriesCount": 0,
    "ErrorEntries": [
      {
        "ErrorMessage": "The id of event target is duplicate!",
        "ErrorCode": "EventRuleTargetIdDuplicate",
        "EntryId": "Mlm123456JHd2RsRoKw"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息
403	ServiceNotEnable	Service not enable

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史