查询所有外部事件源。
接口说明
查询所有外部事件源。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| eventbridge:ListUserDefinedEventSources | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| NamePrefix | string | 否 | 事件源名称。 | testName |
| EventBusName | string | 否 | 事件总线名称。 | testBus |
| Limit | integer | 否 | 限定每次返回的最大条数，可以和 NextToken 搭配使用实现翻页能力。 注意每次返回的最大条数不超过 100。 | 50 |
| NextToken | string | 否 | 当指定 Limit 时，如果还有多余的返回值则会返回 NextToken。 | 100 |
返回参数
返回示例 ： `HTTP/1.1 200 OK Server: AliyunEventBridge Connection: keep-alive Content-Type: application/json;charset=utf-8 Content-Length: 79 x-eventbridge-request-id: 608C6467-3195-42A3-97B5-C51FB976**** Date: Sat, 18 Apr 2020 05:30:41 GMT
{ "code":"200", "data":{ "RequestId":"608C6467-3195-42A3-97B5-C51FB976****", "Data":{ "eventSourceList":[ { "Status":"Activated", "Type":"UserDefined", "Ctime":1626360902642, "EventBusName": "demo-bus", "SourceRocketMQParameters":{ "InstanceId":"MQ_INST_164901546557_BXmr", "Tag":"", "RegionId":"cn-hangzhou", "Topic":"demo-topic", "GroupID":"GID_SOURCE", "Offset":"CONSUME_FROM_LAST_OFFSET" }, "ARN":"acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source", "Name":"demo.source" } ] }, "Code":"Success", "Success":true }, "httpStatusCode":"200", "requestId":"608C6467-3195-42A3-97B5-C51FB976****", "successResponse":true }`
示例
正常返回示例
JSON格式
{
"Message": "InvalidArgument",
"RequestId": "5169654A-7059-57E3-BFD9-33C7E012****",
"Data": {
"NextToken": "100",
"Total": 18,
"EventSourceList": [
{
"Name": "rocketmq.source",
"Arn": "acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source",
"Status": "Activated",
"Type": "UserDefined",
"Ctime": 1607071602000,
"ExternalSourceType": "RabbitMQ",
"EventBusName": "test-custom-bus",
"SourceMNSParameters": {
"RegionId": "cn-hangzhou",
"QueueName": "queue.openapi-sign-callback",
"IsBase64Decode": true
},
"SourceRocketMQParameters": {
"RegionId": "cn-shenzhen",
"InstanceId": "bastionhost-cn-7mz293s9d1p",
"Topic": "migration_instance",
"Tag": "dataact",
"Offset": "CONSUMEFROMLASTOFFSET",
"Timestamp": 1664591760,
"GroupId": "GID-test",
"InstanceType": "CLOUD_5",
"InstanceNetwork": "PublicNetwork",
"InstanceVpcId": "vpc-***",
"InstanceVSwitchIds": "vsw-bp1iu***",
"InstanceSecurityGroupId": "eb-167adad548***",
"AuthType": "ACL",
"InstanceEndpoint": "registry-vpc.cn-hangzhou.aliyuncs.com",
"InstanceUsername": "root",
"InstancePassword": "***"
},
"SourceRabbitMQParameters": {
"RegionId": "cn-hangzhou",
"InstanceId": "bastionhost-cn-0ju2x28fj07",
"VirtualHostName": "eb-connect",
"QueueName": "file-upload-queue"
},
"SourceSLSParameters": {
"Project": "VideoTestProject",
"LogStore": "cloudfirewall-logstore",
"ConsumePosition": "end",
"RoleName": "testRole"
},
"SourceHttpEventParameters": {
"Type": "HTTPS",
"Method": [
"GET"
],
"SecurityConfig": "none",
"Ip": [
"8.212.139.16/32"
],
"Referer": [
"aliyundoc.com\t"
],
"PublicWebHookUrl": [
"http://***.eventbridge.cn-hangzhou.aliyuncs.com/webhook/putEvents?token=***"
],
"VpcWebHookUrl": [
"http://***.eventbridge.cn-hangzhou-vpc.aliyuncs.com/webhook/putEvents?token=0f6705c9253540e1a53e06db011a25b52068562ca50d4818828fffd61c5af***"
]
},
"SourceKafkaParameters": {
"InstanceId": "i-2ze6kiwzkebf04s5h8ds",
"ConsumerGroup": "test-gid",
"Topic": "topic_api_1674441611897",
"OffsetReset": "earliest",
"RegionId": "cn-hangzhou",
"MaximumTasks": 2,
"Network": "Default",
"SecurityGroupId": "sg-f8zatts5g97x0j***",
"VpcId": "vpc-bp1kz3ohhzgrau2***",
"VSwitchIds": "vsw-bp1hcrxq3mkcik***e"
},
"SourceScheduledEventParameters": {
"Schedule": "0 1 * * * *",
"TimeZone": "GMT+0:00",
"UserData": "{\"a\": \"b\"}"
}
}
]
},
"Code": "Success",
"Success": true
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 403 | ServiceNotEnable | Service not enable |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-02-28 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-02-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-10-19 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-01 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-01 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-04-21 | OpenAPI 错误码发生变更 | 查看变更详情 |