創建一個外部事件源。
接口說明
創建一個外部事件源。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
eventbridge:CreateEventSource | create | *EventSource acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/eventsource/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
EventSourceName | string | 是 | 事件源名稱。 | myrabbitmq.sourc |
Description | string | 否 | 事件源描述詳情。 | RabbitMQ事件源 |
LinkedExternalSource | boolean | 否 | 是否連接外部數據源 | true |
ExternalSourceType | byte | 否 | 外部數據源類型 | RabbitMQ |
ExternalSourceConfig | object | 否 | 外部數據源配置 | {\"Schedule\":\"0 */10 * * * *\",\"TimeZone\":\"GMT+0:00\"} |
EventBusName | string | 是 | 與事件源綁定的事件總線的名稱。 | my-event-bus |
SourceMNSParameters | object | 否 | 輕量消息隊列(原 MNS)事件源參數。選擇輕量消息隊列(原 MNS)事件源時 RegionId、IsBase64Decode 和 QueueName 都是必填參數。 | |
RegionId | string | 否 | 輕量消息隊列(原 MNS)的隊列所在的地域。 可以填寫以下地域 :cn-qingdao、cn-beijing、cn-zhangjiakou、cn-huhehaote、cn-wulanchabu、cn-hangzhou、cn-shanghai、cn-shenzhen、cn-guangzhou、cn-chengdu、cn-hongkong、ap-southeast-1、ap-southeast-2、ap-southeast-3、ap-southeast-5、ap-northeast-1、eu-central-1、us-west-1、us-east-1、ap-south-1、me-east-1 和 cn-north-2-gov-1 | cn-hangzhou |
QueueName | string | 否 | 輕量消息隊列(原 MNS)的 Queue 的名稱。 | MyQueue |
IsBase64Decode | boolean | 否 | 是否開啟 Base64 解碼。填寫為 true,即開啟 Base64 解碼。只能填寫 true 或者 false。 | true |
SourceRocketMQParameters | object | 否 | 請求參數 SourceRocketMQParameters。 | |
RegionId | string | 否 | 消息隊列 RocketMQ 版的實例所屬地域。 | cn-hangzhou |
InstanceId | string | 否 | 消息隊列 RocketMQ 版的實例 ID。更多信息,請參見使用限制。 | MQ_INST_164901546557****_BAAN**** |
Topic | string | 否 | 消息隊列 RocketMQ 版實例的 Topic 名稱。更多信息,請參見使用限制。 | mytopic |
Tag | string | 否 | 消息的過濾標簽。 | test |
Offset | string | 否 | 消息的消費位點。取值說明如下: CONSUME_FROM_LAST_OFFSET:從最新位點開始消費。 CONSUME_FROM_FIRST_OFFSET:從最早位點開始消費。 CONSUME_FROM_TIMESTAMP:從指定時間點的位點開始消費。 默認值:CONSUME_FROM_LAST_OFFSET。 | CONSUME_FROM_LAST_OFFSET |
Timestamp | long | 否 | 時間戳。僅當參數 Offset 取值為 CONSUME_FROM_TIMESTAMP 時,該參數有效。 | 1636597951964 |
GroupID | string | 否 | 消息隊列 RocketMQ 版的 Group ID。 | GID-test |
InstanceType | string | 否 | 實例類型 :
| Cloud_4 |
InstanceNetwork | string | 否 | 無 | 無 |
InstanceVpcId | string | 否 | 專有網絡需要添加 :vpcId | vpc-bp1a4gmlk31hyg6pt**** |
InstanceVSwitchIds | string | 否 | 專有網絡需要添加 :vSwitchId | vsw-bp10rbrt6rb6vrd89**** |
InstanceSecurityGroupId | string | 否 | 專有網絡需要添加 :securityGroupId | sg-catalog-eventlist**** |
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。更多信息,請參見使用限制。 | amqp-cn-nif22u74**** |
VirtualHostName | string | 否 | 消息隊列 RabbitMQ 版實例的 Vhost 的名稱。更多信息,請參見使用限制。 | eb-connect |
QueueName | string | 否 | eb-connect 消息隊列 RabbitMQ 版實例的 Queue 的名稱。更多信息,請參見使用限制。 | demo |
SourceSLSParameters | object | 否 | SourceSLSParameters | |
Project | string | 否 | 日志服務 SLS 的日志項目。 | test-project |
LogStore | string | 否 | 日志服務 SLS 的日志庫。 | test-logstore |
ConsumePosition | string | 否 | 起始消費位點,可以選擇最早或最新位點,分別對應“begin”,“end”,也可以從指定時間開始消費,以秒為單位。 | end |
RoleName | string | 否 | 授權事件總線 EventBridge 使用此角色讀取 SLS 日志內容時,需滿足條件:在 RAM 控制臺創建服務所使用的角色時,需要選擇“阿里云服務”,并且“受信服務”需要選擇“事件總線”。此角色權限策略可參考自定義事件源日志服務 SLS。 | testRole |
SourceHttpEventParameters | object | 否 | 請求參數 SourceHttpEventParameters | |
Type | string | 否 | 生成的 Webhook 支持的協議類型。取值說明如下:
| HTTPS |
Method | array | 否 | 生成的 Webhook 支持的 HTTP 請求方法。可多選,可選范圍如下:
| |
string | 否 | 生成的 Webhook 支持的 HTTP 請求方法??啥噙x,可選范圍如下:
| GET | |
SecurityConfig | string | 否 | 選擇安全配置的類型。可選范圍如下:
| none |
Ip | array | 否 | IP 網段安全配置。僅在 SecurityConfig 取值為 ip 時,需要設置該參數??商顚?IP 地址段或 IP 地址。 | |
string | 否 | IP 網段安全配置。僅在 SecurityConfig 取值為 ip 時,需要設置該參數??商顚?IP 地址段或 IP 地址。 | 10.0.0.0/8 | |
Referer | array | 否 | 安全域名配置。僅在 SecurityConfig 取值為 referer 時,需要設置該參數。可填寫域名。 | |
string | 否 | 安全域名配置。僅在 SecurityConfig 取值為 referer 時,需要設置該參數。可填寫域名。 | aliyundoc.com | |
SourceScheduledEventParameters | object | 否 | 請求參數 SourceScheduledEventParameters | |
Schedule | string | 否 | Cron 表達式。 | 10 * * * * * |
TimeZone | string | 否 | Cron 執行時區。 | GMT+0:00 |
UserData | string | 否 | JSON 字符串 | {"a": "b"} |
SourceKafkaParameters | object | 否 | 請求參數 SourceKafkaParameters | |
InstanceId | string | 否 | 實例 ID。 | pc-2zehmg67txzuyuuwl**** |
ConsumerGroup | string | 否 | 訂閱該 Topic 的消費者所對應的 Group ID。 | wechat_peer_**** |
Topic | string | 否 | Topic 名稱。 | prod_ma_dispatch_center_call_re**** |
OffsetReset | string | 否 | 消費位點。 | latest |
RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
MaximumTasks | integer | 否 | 并發配額(消費者數) | 1 |
Network | string | 否 | 網絡配置 :Default(默認網絡)和 PublicNetwork(自建網絡)。 | Default |
SecurityGroupId | string | 否 | 如果是自建網絡需要添加:安全組 id | sg-8vbf66aoyp0wfzrz**** |
VSwitchIds | string | 否 | 如果是自建網絡需要添加:vSwitchId | vsw-bp127azpeirmwu4q9**** |
VpcId | string | 否 | 如果是自建網絡需要添加:vpcId | vpc-2ze5ejm986a73qq3v**** |
請求示例 `POST /openapi/createEventSource 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":"myRabbitMQ.source", "Description":"RabbitMQ 事件源", "SourceRabbitMQParameters":{ "RegionId":"cn-hangzhou", "InstanceId":"amqp-cn-nif22u74****", "VirtualHostName":"eb-connect", "QueueName":"demo" }, "EventBusName":"my-event-bus" }`
返回參數
示例
正常返回示例
JSON
格式
{
"Message": " Remote error. requestId: [A8EFABD2-95B9-1C46-9E01-xxxx], error code: [CreateRelatedResourceFailed], message: [Create related resource failed, EntityNotExist.Role : The role not exists: xxxx. \\r\\nRequestId : xxxx-168C-54ED-8FEB-BF11CB70AEB7] ",
"RequestId": "2922208e-e1c6-43ee-bfd1-aca50263bc8a",
"Data": {
"EventSourceARN": "acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/mymns.source"
},
"Code": "Success",
"Success": true
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 |
---|---|---|
403 | ServiceNotEnable | Service not enable |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-10-19 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-01 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-01 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-04-21 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-04-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |