调用ListUserDefinedEventSources接口查询所有外部事件源。

URI

/openapi/listUserDefinedEventSources

注意事项

参数SourceMNSParameters、SourceRocketMQParameters、SourceRabbitMQParameters、SourceHttpEventParameters和SourceSLSParameters同时只能返回一个。

请求参数

无。

返回参数

名称 类型 示例值 描述
Status String Activated 查询到的事件源的状态。
取值说明如下：
  • Activated：激活状态
Type String UserDefined 查询到的事件源的类型。
取值说明如下：
  • UserDefined：外部事件源
SourceMNSParameters Object 事件提供方为消息服务MNS。
SourceRocketMQParameters Object 事件提供方为消息队列RocketMQ版。
SourceRabbitMQParameters Object 事件提供方为消息队列RabbitMQ版。
SourceHttpEventParameters Object 事件提供方为HTTP/HTTPS。
SourceSLSParameters Object 事件提供方为日志服务SLS。
Ctime String 1626360902642 查询到的事件源的创建时间。单位为毫秒级。
EventBusName String demo-bus 查询到的事件源所关联的事件总线。
ARN String acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source 查询到的事件源在阿里云上的统一资源标识（ARN）。
Name String rocketmq.source 查询到的事件源的名称。

返回参数SourceMNSParameters

名称 类型 示例值 描述
RegionId String cn-zhangjiakou 消息服务MNS的队列所在的地域。
QueueName String MyQueue 消息服务MNS的Queue的名称。
IsBase64Decode String true 是否开启Base64编码。

返回参数SourceRocketMQParameters

名称 类型 示例值 描述
RegionId String cn-zhangjiakou 消息队列RocketMQ版的实例所属地域。
InstanceId String MQ_INST_164901546557****_BAAN**** 消息队列RocketMQ版的实例ID。更多信息，请参见使用限制。
Topic String mytopic 消息队列RocketMQ版实例的Topic名称。更多信息，请参见使用限制。
Tag String test 消息的过滤标签。
Offset String CONSUME_FROM_TIMESTAMP 消息的消费位点。取值说明如下：
  • CONSUME_FROM_LAST_OFFSET：从最新位点开始消费。
  • CONSUME_FROM_FIRST_OFFSET：从最早位点开始消费。
  • CONSUME_FROM_TIMESTAMP：从指定时间点的位点开始消费。
Timestamp Long 1636597951964 时间戳。仅当参数Offset取值为CONSUME_FROM_TIMESTAMP时，该参数有效。
GroupID String GID_group1 消息队列RocketMQ版的Group ID。

返回参数SourceRabbitMQParameters

名称 类型 示例值 描述
RegionId String cn-zhangjiakou 消息队列RabbitMQ版实例所在的地域。
InstanceId String amqp-cn-nif22u74**** 消息队列RabbitMQ版的实例的ID。更多信息，请参见使用限制。
VirtualHostName String eb-connect 消息队列RabbitMQ版实例的Vhost的名称。更多信息，请参见使用限制。
QueueName String demo 消息队列RabbitMQ版实例的Queue的名称。更多信息，请参见使用限制。

返回参数SourceHttpEventParameters

名称 类型 是否必选 示例值 描述
Type String 是 HTTPS 生成的Webhook支持的协议类型。取值说明如下：
  • HTTP
  • HTTPS
  • HTTP&HTTPS
Method List 是 GET 生成的Webhook支持的HTTP请求方法。可多选，可选范围如下：
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
  • HEAD
  • OPTIONS
  • TRACE
  • CONNECT
SecurityConfig String 是 ip 选择安全配置的类型。可选范围如下：
  • none：无需配置。
  • ip：IP网段。
  • referer：安全域名。
Ip List 否 10.0.0.0/8 IP网段安全配置。仅在SecurityConfig取值为ip时，需要设置该参数。可填写IP地址段或IP地址。
Referer List 否 aliyundoc.com 安全域名配置。仅在SecurityConfig取值为referer时，需要设置该参数。可填写域名。

返回参数SourceSLSParameters

名称 类型 是否必选 示例值 描述
Project String 是 test-project 日志服务SLS的日志项目。
LogStore String 是 test-logstore 日志服务SLS的日志库。
ConsumePosition String 否 end 起始消费位点，可以选择最早或最新位点，分别对应“begin”，“end”，也可以从指定时间开始消费，以秒为单位。
RoleName String 是 testRole 授权事件总线EventBridge使用此角色读取SLS日志内容时，需满足条件：在RAM控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。

示例

请求示例

POST /openapi/listUserDefinedEventSources HTTP/1.1
Host: 123456789098****.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

返回示例

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
}