更新一個(gè)事件源的配置。
接口說明
更新一個(gè)事件源的配置。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
eventbridge:UpdateEventSource | update |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
EventSourceName | string | 是 | 事件源名稱。 | myrabbitmq.source |
Description | string | 否 | 事件源描述詳情。 | RabbitMQ事件源 |
LinkedExternalSource | boolean | 否 | 是否連接外部數(shù)據(jù)源 | true |
ExternalSourceType | string | 否 | 外部數(shù)據(jù)源類型 | SLS |
ExternalSourceConfig | object | 否 | 外部數(shù)據(jù)源配置 | {\"ConsumePosition\":\"end\",\"LogStore\":\"oss_log\",\"Project\":\"slsaudit-center-5795350335281001-cn-beijing\",\"RoleName\":\"sls-beijing-tf\"} |
EventBusName | string | 是 | 綁定的總線。 | my-event-bus |
SourceMNSParameters | object | 否 | 輕量消息隊(duì)列(原 MNS)事件源參數(shù)。 | |
RegionId | string | 否 | 輕量消息隊(duì)列(原 MNS)的隊(duì)列所在的地域。 | cn-beijing |
QueueName | string | 否 | 輕量消息隊(duì)列(原 MNS)的 Queue 的名稱。 | queue_api_bind_1672194645178 |
IsBase64Decode | boolean | 否 | 是否開啟 Base64 解碼。默認(rèn)為勾選,即開啟 Base64 解碼。 | true |
SourceRocketMQParameters | object | 否 | 請求參數(shù) SourceRocketMQParameters | |
RegionId | string | 否 | 消息隊(duì)列 RocketMQ 版的實(shí)例所屬地域。 | cn-zhangjiakou |
InstanceId | string | 否 | 消息隊(duì)列 RocketMQ 版的實(shí)例 ID。更多信息,請參見使用限制。 | dbaudit-cn-i7m2nx**** |
Topic | string | 否 | 消息隊(duì)列 RocketMQ 版實(shí)例的 Topic 名稱。更多信息,請參見使用限制。 | topic_default_195820716552192 |
Tag | string | 否 | 消息的過濾標(biāo)簽。 | KEY2 |
Offset | string | 否 | 消息的消費(fèi)位點(diǎn)。取值說明如下:
默認(rèn)值:CONSUME_FROM_LAST_OFFSET。 | CONSUMEFROMLASTOFFSET |
Timestamp | long | 否 | 時(shí)間戳。僅當(dāng)參數(shù) Offset 取值為 CONSUME_FROM_TIMESTAMP 時(shí),該參數(shù)有效。 | 1663555399032 |
GroupID | string | 否 | 消息隊(duì)列 RocketMQ 版的 Group ID。 | GID-test |
InstanceType | string | 否 | 實(shí)例類型 :
| Cloud_4 |
InstanceNetwork | string | 否 | 無 | 無 |
InstanceVpcId | string | 否 | 專有網(wǎng)絡(luò)需要添加 vpcId。 | vpc-bp1a4gmlk31hyg6pt**** |
InstanceVSwitchIds | string | 否 | 專有網(wǎng)絡(luò)需要添加 vSwitchId。 | vsw-bp10rbrt6rb6vrd89**** |
InstanceSecurityGroupId | string | 否 | 專有網(wǎng)絡(luò)需要添加 securityGroupId。 | sg-catalog-eventlistener |
AuthType | string | 否 | ACL 或者不填。 | ACL |
InstanceEndpoint | string | 否 | 實(shí)例接入點(diǎn)。 | registry-vpc****.aliyuncs.com |
InstanceUsername | string | 否 | 實(shí)例用戶名。 | root |
InstancePassword | string | 否 | 實(shí)例密碼。 | ****** |
SourceRabbitMQParameters | object | 否 | 請求參數(shù) SourceRabbitMQParameters | |
RegionId | string | 否 | 消息隊(duì)列 RabbitMQ 版實(shí)例所在的地域。 | cn-hangzhou |
InstanceId | string | 否 | 消息隊(duì)列 RabbitMQ 版的實(shí)例的 ID。更多信息,請參見使用限制。 | bastionhost-cn-7mz2zky**** |
VirtualHostName | string | 否 | 消息隊(duì)列 RabbitMQ 版實(shí)例的 Vhost 的名稱。更多信息,請參見使用限制。 | amqp-cn-nif22u74**** |
QueueName | string | 否 | eb-connect 消息隊(duì)列 RabbitMQ 版實(shí)例的 Queue 的名稱。更多信息,請參見使用限制。 | eb-connect |
SourceSLSParameters | object | 否 | SourceSLSParameters | |
Project | string | 否 | 日志服務(wù) SLS 的日志項(xiàng)目。 | VideoTestProject |
LogStore | string | 否 | 日志服務(wù) SLS 的日志庫。 | waf-logstore |
ConsumePosition | string | 否 | 起始消費(fèi)位點(diǎn),可以選擇最早或最新位點(diǎn),分別對(duì)應(yīng)“begin”,“end”,也可以從指定時(shí)間開始消費(fèi),以秒為單位。 | end |
RoleName | string | 否 | 授權(quán)事件總線 EventBridge 使用此角色讀取 SLS 日志內(nèi)容時(shí),需滿足條件:在 RAM 控制臺(tái)創(chuàng)建服務(wù)所使用的角色時(shí),需要選擇“阿里云服務(wù)”,并且“受信服務(wù)”需要選擇“事件總線”。此角色權(quán)限策略可參考自定義事件源日志服務(wù) SLS。 | testRole |
SourceScheduledEventParameters | object | 否 | 請求參數(shù) SourceScheduledEventParameters | |
Schedule | string | 否 | Cron 表達(dá)式。 | 10 * * * * * |
TimeZone | string | 否 | Cron 執(zhí)行時(shí)區(qū)。 | GMT+0:00 |
UserData | string | 否 | JSON 字符串 | {"a": "b"} |
SourceHttpEventParameters | object | 否 | 請求參數(shù) SourceHttpEventParameters | |
Type | string | 否 | 生成的 Webhook 支持的協(xié)議類型。取值說明如下:
| HTTPS |
Method | array | 否 | 生成的 Webhook 支持的 HTTP 請求方法。可多選,可選范圍如下:
| |
string | 否 | 生成的 Webhook 支持的 HTTP 請求方法??啥噙x,可選范圍如下:
| GET | |
SecurityConfig | string | 否 | 選擇安全配置的類型。可選范圍如下:
| none |
Ip | array | 否 | IP 網(wǎng)段安全配置。僅在 SecurityConfig 取值為 ip 時(shí),需要設(shè)置該參數(shù)??商顚?IP 地址段或 IP 地址。 | |
string | 否 | IP 網(wǎng)段安全配置。僅在 SecurityConfig 取值為 ip 時(shí),需要設(shè)置該參數(shù)??商顚?IP 地址段或 IP 地址。 | 47.252.126.0/24 | |
Referer | array | 否 | 安全域名配置。僅在 SecurityConfig 取值為 referer 時(shí),需要設(shè)置該參數(shù)??商顚懹蛎?。 | |
string | 否 | 安全域名配置。僅在 SecurityConfig 取值為 referer 時(shí),需要設(shè)置該參數(shù)??商顚懹蛎?/p> | aliyundoc.com | |
SourceKafkaParameters | object | 否 | 請求參數(shù) SourceKafkaParameters | |
InstanceId | string | 否 | 實(shí)例 ID。 | cbwp-bp1o3m66wcjgbkssm3**** |
ConsumerGroup | string | 否 | 訂閱該 Topic 的消費(fèi)者所對(duì)應(yīng)的 Group ID。 | dsp_online_ml_request |
Topic | string | 否 | Topic 名稱。 | billing_notify |
OffsetReset | string | 否 | 消費(fèi)位點(diǎn)。 | latest |
RegionId | string | 否 | 地域 ID。 | cn-shanghai |
MaximumTasks | integer | 否 | 并發(fā)配額(消費(fèi)者數(shù))。 | 1 |
Network | string | 否 | 網(wǎng)絡(luò)配置 :Default(默認(rèn)網(wǎng)絡(luò))和 PublicNetwork(自建網(wǎng)絡(luò))。 | Default |
SecurityGroupId | string | 否 | 如果是自建網(wǎng)絡(luò)需要添安全組 ID。 | sg-5wz3mjgo9wpvdnwpwnhkj**** |
VpcId | string | 否 | 如果是自建網(wǎng)絡(luò)需要添加 vpcId。 | vpc-2zefu4vfmx6sioguj**** |
VSwitchIds | string | 否 | 如果是自建網(wǎng)絡(luò)需要添加 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" }`
返回參數(shù)
示例
正常返回示例
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
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 |
---|---|---|
403 | ServiceNotEnable | Service not enable |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-10-19 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-08-01 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-04-21 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-04-06 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |