AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

UpdateEventSource - 更新一个事件源

更新时间：
复制为 MD 格式
产品详情
我的收藏

更新一个事件源的配置。

接口说明

更新一个事件源的配置。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eventbridge:UpdateEventSource

update

*EventSource

acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/eventsource/{#EventSourceName}

 无 无

请求参数

名称

类型

必填

描述

示例值
EventSourceName

string

是

事件源名称。

myrabbitmq.source
Description

string

否

事件源描述详情。

Event source of the RabbitMQ type
LinkedExternalSource

boolean

否

是否连接外部数据源

true
ExternalSourceType

string

否

外部数据源类型

SLS
ExternalSourceConfig

object

否

外部数据源配置

{\"ConsumePosition\":\"end\",\"LogStore\":\"oss_log\",\"Project\":\"slsaudit-center-5795350335281001-cn-beijing\",\"RoleName\":\"sls-beijing-tf\"}
EventBusName

string

是

绑定的总线。

my-event-bus

SourceMNSParameters

object

否

轻量消息队列（原 MNS）事件源参数。

RegionId

string

否

轻量消息队列（原 MNS）的队列所在的地域。

cn-beijing
QueueName

string

否

轻量消息队列（原 MNS）的 Queue 的名称。

queue_api_bind_1672194645178
IsBase64Decode

boolean

否

是否开启 Base64 解码。默认为勾选，即开启 Base64 解码。

true
SourceRocketMQParameters

object

否

请求参数 SourceRocketMQParameters

RegionId

string

否

消息队列 RocketMQ 版的实例所属地域。

cn-zhangjiakou
InstanceId

string

否

消息队列 RocketMQ 版的实例 ID。更多信息，请参见使用限制。

dbaudit-cn-i7m2nx****
Topic

string

否

消息队列 RocketMQ 版实例的 Topic 名称。更多信息，请参见使用限制。

topic_default_195820716552192
Tag

string

否

消息的过滤标签。

KEY2
Offset

string

否

消息的消费位点。取值说明如下：

  • CONSUME_FROM_LAST_OFFSET：从最新位点开始消费。

  • CONSUME_FROM_FIRST_OFFSET：从最早位点开始消费。

  • CONSUME_FROM_TIMESTAMP：从指定时间点的位点开始消费。

默认值：CONSUME_FROM_LAST_OFFSET。

CONSUMEFROMLASTOFFSET
Timestamp

integer

否

时间戳。仅当参数 Offset 取值为 CONSUME_FROM_TIMESTAMP 时，该参数有效。

1663555399032
GroupID

string

否

消息队列 RocketMQ 版的 Group ID。

GID-test

InstanceType

string

否

实例类型 ：

  • 4.0 实例填写 ：Cloud_4

  • 5.0 实例填写 ：Cloud_5

Cloud_4
InstanceNetwork

string

否

无

InstanceVpcId

string

否

专有网络需要添加 vpcId。

vpc-bp1a4gmlk31hyg6pt****
InstanceVSwitchIds

string

否

专有网络需要添加 vSwitchId。

vsw-bp10rbrt6rb6vrd89****

InstanceSecurityGroupId

string

否

专有网络需要添加 securityGroupId。

sg-catalog-eventlistener

AuthType

string

否

ACL 或者不填。

ACL
InstanceEndpoint

string

否

实例接入点。

registry-vpc****.aliyuncs.com

InstanceUsername

string

否

实例用户名。

root
InstancePassword

string

否

实例密码。

******
SourceRabbitMQParameters

object

否

请求参数 SourceRabbitMQParameters

RegionId

string

否

消息队列 RabbitMQ 版实例所在的地域。

cn-hangzhou
InstanceId

string

否

消息队列 RabbitMQ 版的实例的 ID。更多信息，请参见使用限制。

bastionhost-cn-7mz2zky****
VirtualHostName

string

否

消息队列 RabbitMQ 版实例的 Vhost 的名称。更多信息，请参见使用限制。

amqp-cn-nif22u74****

QueueName

string

否

eb-connect 消息队列 RabbitMQ 版实例的 Queue 的名称。更多信息，请参见使用限制。

eb-connect
SourceSLSParameters

object

否

SourceSLSParameters

Project

string

否

日志服务 SLS 的日志项目。

VideoTestProject
LogStore

string

否

日志服务 SLS 的日志库。

waf-logstore
ConsumePosition

string

否

起始消费位点，可以选择最早或最新位点，分别对应“begin”，“end”，也可以从指定时间开始消费，以秒为单位。

end
RoleName

string

否

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。此角色权限策略可参考自定义事件源日志服务 SLS。

testRole
SourceScheduledEventParameters

object

否

请求参数 SourceScheduledEventParameters

Schedule

string

否

Cron 表达式。

10 * * * * *

TimeZone

string

否

Cron 执行时区。

GMT+0:00

UserData

string

否

JSON 字符串

{"a": "b"}
SourceHttpEventParameters

object

否

请求参数 SourceHttpEventParameters

Type

string

否

生成的 Webhook 支持的协议类型。取值说明如下：

  • HTTP

  • HTTPS

  • HTTP&HTTPS

HTTPS
Method

array

否

生成的 Webhook 支持的 HTTP 请求方法。可多选，可选范围如下：

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

  • HEAD

  • OPTIONS

  • TRACE

  • CONNECT

string

否

生成的 Webhook 支持的 HTTP 请求方法。可多选，可选范围如下：

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

  • HEAD

  • OPTIONS

  • TRACE

  • CONNECT

GET
SecurityConfig

string

否

选择安全配置的类型。可选范围如下：

  • none：无需配置。

  • ip：IP 网段。

  • referer：安全域名。

none
Ip

array

否

IP 网段安全配置。仅在 SecurityConfig 取值为 ip 时，需要设置该参数。可填写 IP 地址段或 IP 地址。

string

否

IP 网段安全配置。仅在 SecurityConfig 取值为 ip 时，需要设置该参数。可填写 IP 地址段或 IP 地址。

47.252.126.0/24
Referer

array

否

安全域名配置。仅在 SecurityConfig 取值为 referer 时，需要设置该参数。可填写域名。

string

否

安全域名配置。仅在 SecurityConfig 取值为 referer 时，需要设置该参数。可填写域名。

aliyundoc.com

SourceKafkaParameters

object

否

请求参数 SourceKafkaParameters

InstanceId

string

否

实例 ID。

cbwp-bp1o3m66wcjgbkssm3****
ConsumerGroup

string

否

订阅该 Topic 的消费者所对应的 Group ID。

dsp_online_ml_request
Topic

string

否

Topic 名称。

billing_notify
OffsetReset

string

否

消费位点。

latest
RegionId

string

否

地域 ID。

cn-shanghai
MaximumTasks

integer

否

并发配额（消费者数）。

1
Network

string

否

网络配置 ：Default（默认网络）和 PublicNetwork（自建网络）。

Default
SecurityGroupId

string

否

如果是自建网络需要添安全组 ID。

sg-5wz3mjgo9wpvdnwpwnhkj****
VpcId

string

否

如果是自建网络需要添加 vpcId。

vpc-2zefu4vfmx6sioguj****
VSwitchIds

string

否

如果是自建网络需要添加 vSwitchId。

vsw-bp1xyntcxiwplhqxj****
SourceOSSEventParameters

object

否

OSS 事件源参数。

EventTypes

array

否

事件类型列表。

string

否

事件类型。

StsRoleArn

string

否

STS 角色 ARN。

MatchRules

array<object>

否

匹配规则。

array<object>

否

object

否

Suffix

string

否

后缀。

MatchState

boolean

否

匹配状态。

Prefix

string

否

前缀。

Name

string

否

名称。

请求示例 ： `POST /openapi/updateEventSource HTTP/1.1 Host: 164901546557****.eventbridge.cn-hangzhou.aliyuncs.com Date: Sat, 18 Apr 2020 05:30:41 GMT x-eventbridge-version: 2020-04-01 Authorization: acs vZ3VL0SuJdHi****:Jo2PbT******azYAYoYslKLvWzg= Content-Type: application/json;charset=UTF-8 Content-Length: 26

{ "EventSourceName":"myRocketMQ.source", "Description":"RocketMQ 事件源", "SourceRocketMQParameters":{ "InstanceId":"MQ_INST_164901546557_BAAN", "GroupID":"GID_group1", "Topic":"mytopic", "Offset":"CONSUME_FROM_LAST_OFFSET", "Tag":"test", "RegionId":"cn-hangzhou" }, "EventBusName":"my-event-bus" }`

返回参数

名称

类型

描述

示例值

object

请求体参数。

Message

string

错误信息。

Remote error. requestId: [xxxx-9D10-65DFDFA3A75D], error code: [EventSourceNotExist], message: [The event source in request is not exist! ]
RequestId

string

阿里云为该请求生成的唯一标识符。

c057d379-ea65-41ec-a8a8-90627a9****
Data

boolean

更新结果。

true
Code

string

接口返回码：

  • Success：表示成功。

  • 其它：表示错误码。错误码详情，请参见错误码。

Success
Success

boolean

操作成功返回 true。

true

示例

正常返回示例

JSON格式

{
  "Message": "Remote error. requestId: [xxxx-9D10-65DFDFA3A75D], error code: [EventSourceNotExist], message: [The event source in request is not exist! ]",
  "RequestId": "c057d379-ea65-41ec-a8a8-90627a9****",
  "Data": true,
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述
403 ServiceNotEnable Service not enable

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

变更历史

更多信息，参考变更详情。

上一篇：DeleteEventSource - 删除一个事件源下一篇：事件目标