Queries all custom event sources.
URI
/openapi/listUserDefinedEventSources
Usage notes
Only one of the SourceMNSParameters, SourceRocketMQParameters, and SourceRabbitMQParameters parameters can be returned for an event source.
Request parameters
None
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Status | String | Activated | The status of the event source returned.
Valid values:
|
Type | String | UserDefined | The type of the event source.
Valid values:
|
SourceMNSParameters | Object | The resource information configured when the event provider is MNS. | |
SourceRocketMQParameters | Object | The resource information configured when the event provider is Message Queue for Apache RocketMQ. | |
SourceRabbitMQParameters | Object | The resource information configured when the event provider is Message Queue for RabbitMQ. | |
Ctime | String | 1626360902642 | The time when the event source was created. Unit: milliseconds. |
EventBusName | String | demo-bus | The name of the event bus with which the event source is associated. |
ARN | String | acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source | The Alibaba Cloud Resource Name (ARN) of the event source. |
Name | String | rocketmq.source | The name of the event source. |
Response parameter SourceMNSParameters
Parameter | Type | Example | Description |
---|---|---|---|
RegionId | String | cn-zhangjiakou | The ID of the region where the MNS queue resides. |
QueueName | String | MyQueue | The name of the MNS queue. |
IsBase64Decode | String | true | Indicates whether Base64 decoding is enabled. |
Response parameter SourceRocketMQParameters
Parameter | Type | Example | Description |
---|---|---|---|
RegionId | String | cn-zhangjiakou | The ID of the region where the Message Queue for Apache RocketMQ instance resides. |
InstanceId | String | MQ_INST_164901546557****_BAAN**** | The ID of the Message Queue for Apache RocketMQ instance. For more information, see Limits. |
Topic | String | mytopic | The name of the topic in the Message Queue for Apache RocketMQ instance. For more information, see Limits. |
Tag | String | test | The tag that is used to filter messages. |
Offset | String | CONSUME_FROM_TIMESTAMP | The consumer offset of the message. Valid values:
|
Timestamp | Long | 1636597951964 | The timestamp of the offset from which the consumption starts. This parameter is valid only when the Offset parameter is set to CONSUME_FROM_TIMESTAMP. |
GroupID | String | GID_group1 | The ID of the group in Message Queue for Apache RocketMQ. |
Response parameter SourceRabbitMQParameters
Parameter | Type | Example | Description |
---|---|---|---|
RegionId | String | cn-zhangjiakou | The ID of the region where the Message Queue for RabbitMQ instance resides. |
InstanceId | String | amqp-cn-nif22u74**** | The ID of the Message Queue for RabbitMQ instance. For more information, see Limits. |
VirtualHostName | String | eb-connect | The name of the vhost in the Message Queue for RabbitMQ instance. For more information, see Limits. |
QueueName | String | demo | The name of the queue in the Message Queue for RabbitMQ instance. For more information, see Limits. |
Examples
Sample requests
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
Sample responses
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
}