文档

UpdateEventSource - 更新一个事件源

更新时间:

更新一个事件源的配置。

接口说明

更新一个事件源的配置。

调试

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

授权信息

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

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

请求参数

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

事件源名称。

myrabbitmq.source
Descriptionstring

事件源描述详情。

RabbitMQ事件源
EventBusNamestring

绑定的总线。

my-event-bus
SourceMNSParametersobject

MNS 事件源参数

RegionIdstring

消息服务 MNS 的队列所在的地域。

cn-beijing
QueueNamestring

消息服务 MNS 的 Queue 的名称。

queue_api_bind_1672194645178
IsBase64Decodeboolean

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

true
SourceRocketMQParametersobject

请求参数 SourceRocketMQParameters

RegionIdstring

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

cn-zhangjiakou
InstanceIdstring

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

dbaudit-cn-i7m2nx****
Topicstring

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

topic_default_195820716552192
Tagstring

消息的过滤标签。

KEY2
Offsetstring

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

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

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

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

默认值:CONSUME_FROM_LAST_OFFSET。

CONSUMEFROMLASTOFFSET
Timestamplong

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

1663555399032
GroupIDstring

消息队列 RocketMQ 版的 Group ID。

GID-test
InstanceTypestring

实例类型 :

  • 4.0 实例填写 :Cloud_4

  • 5.0 实例填写 :Cloud_5

Cloud_4
InstanceNetworkstring

InstanceVpcIdstring

专有网络需要添加 vpcId。

vpc-bp1a4gmlk31hyg6pt****
InstanceVSwitchIdsstring

专有网络需要添加 vSwitchId。

vsw-bp10rbrt6rb6vrd89****
InstanceSecurityGroupIdstring

专有网络需要添加 securityGroupId。

sg-catalog-eventlistener
AuthTypestring

ACL 或者不填。

ACL
InstanceEndpointstring

实例接入点。

registry-vpc****.aliyuncs.com
InstanceUsernamestring

实例用户名。

root
InstancePasswordstring

实例密码。

******
SourceRabbitMQParametersobject

请求参数 SourceRabbitMQParameters

RegionIdstring

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

cn-hangzhou
InstanceIdstring

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

bastionhost-cn-7mz2zky****
VirtualHostNamestring

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

amqp-cn-nif22u74****
QueueNamestring

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

eb-connect
SourceSLSParametersobject

SourceSLSParameters

Projectstring

日志服务 SLS 的日志项目。

VideoTestProject
LogStorestring

日志服务 SLS 的日志库。

waf-logstore
ConsumePositionstring

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

end
RoleNamestring

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

testRole
SourceScheduledEventParametersobject

请求参数 SourceScheduledEventParameters

Schedulestring

Cron 表达式。

10 * * * * *
TimeZonestring

Cron 执行时区。

GMT+0:00
UserDatastring

JSON 字符串

{"a": "b"}
SourceHttpEventParametersobject

请求参数 SourceHttpEventParameters

Typestring

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

  • HTTP

  • HTTPS

  • HTTP&HTTPS

HTTPS
Methodarray

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

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

  • HEAD

  • OPTIONS

  • TRACE

  • CONNECT

string

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

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

  • HEAD

  • OPTIONS

  • TRACE

  • CONNECT

GET
SecurityConfigstring

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

  • none:无需配置。

  • ip:IP 网段。

  • referer:安全域名。

none
Iparray

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

string

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

47.252.126.0/24
Refererarray

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

string

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

aliyundoc.com
SourceKafkaParametersobject

请求参数 SourceKafkaParameters

InstanceIdstring

实例 ID。

cbwp-bp1o3m66wcjgbkssm3****
ConsumerGroupstring

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

dsp_online_ml_request
Topicstring

Topic 名称。

billing_notify
OffsetResetstring

消费位点。

latest
RegionIdstring

地域 ID。

cn-shanghai
MaximumTasksinteger

并发配额(消费者数)。

1
Networkstring

网络配置 :Default(默认网络)和 PublicNetwork(自建网络)。

Default
SecurityGroupIdstring

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

sg-5wz3mjgo9wpvdnwpwnhkj****
VpcIdstring

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

vpc-2zefu4vfmx6sioguj****
VSwitchIdsstring

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

vsw-bp1xyntcxiwplhqxj****

请求示例 : `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
Messagestring

错误信息

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

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

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

更新结果

true
Codestring

接口返回码:

  • Success:表示成功。

  • 其它:表示错误码。错误码详情,请参见错误码。

Success
Successboolean

操作成功返回 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错误码错误信息
403ServiceNotEnableService not enable

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

变更历史

变更时间变更内容概要操作
2023-10-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
2023-08-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
2023-04-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:SourceScheduledEventParameters
    新增入参:SourceKafkaParameters
2023-04-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
  • 本页导读 (1)