ListUserDefinedEventSources - 查询所有外部事件源

查询所有外部事件源。

接口说明

查询所有外部事件源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eventbridge:ListUserDefinedEventSourcesget
*EventSource
acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/eventsource/*

请求参数

名称类型必填描述示例值
NamePrefixstring

事件源名称。

testName
EventBusNamestring

事件总线名称。

testBus
Limitinteger

限定每次返回的最大条数,可以和 NextToken 搭配使用实现翻页能力。 注意每次返回的最大条数不超过 100。

50
NextTokenstring

当指定 Limit 时,如果还有多余的返回值则会返回 NextToken。

100

返回参数

名称类型描述示例值
object
Messagestring

错误信息。

InvalidArgument
RequestIdstring

阿里云为该请求生成的唯一标识符。

5169654A-7059-57E3-BFD9-33C7E012****
Dataobject

返回数据。

NextTokenstring

当指定 Limit 时,如果还有多余的返回值则会返回 NextToken。

100
Totalinteger

总条数

18
EventSourceListarray<object>

事件源列表。

eventSourceListobject

事件源数据结构。

Namestring

查询到的事件源的名称。

rocketmq.source
Arnstring

查询到的事件源在阿里云上的统一资源标识(ARN)。

acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
Statusstring

查询到的事件源的状态。 取值说明如下: Activated:激活状态

Activated
Typestring

查询到的事件源的类型。 取值说明如下: UserDefined:外部事件源

UserDefined
Ctimefloat

创建时间戳。

1607071602000
ExternalSourceTypestring

事件来源类型。

RabbitMQ
EventBusNamestring

事件总线的名称。

test-custom-bus
SourceMNSParametersobject

轻量消息队列(原 MNS)事件源参数。

RegionIdstring

轻量消息队列(原 MNS)的队列所在的地域。

cn-hangzhou
QueueNamestring

轻量消息队列(原 MNS)的 Queue 的名称。

queue.openapi-sign-callback
IsBase64Decodeboolean

是否开启 Base64 解码。默认为勾选,即开启 Base64 解码。

true
SourceRocketMQParametersobject

请求参数 SourceRocketMQParameters。

RegionIdstring

消息队列 RocketMQ 版的实例所属地域。

cn-shenzhen
InstanceIdstring

消息队列 RocketMQ 版的实例 ID。更多信息,请参见使用限制

bastionhost-cn-7mz293s9d1p
Topicstring

消息队列 RocketMQ 版实例的 Topic 名称。更多信息,请参见使用限制

migration_instance
Tagstring

消息的过滤标签。

dataact
Offsetstring

消息的消费位点。取值说明如下:

  • CONSUME_FROM_LAST_OFFSET:从最新位点开始消费。

  • CONSUME_FROM_FIRST_OFFSET:从最早位点开始消费。

  • CONSUME_FROM_TIMESTAMP:从指定时间点的位点开始消费。

默认值:CONSUME_FROM_LAST_OFFSET。

CONSUMEFROMLASTOFFSET
Timestampfloat

时间戳。仅当参数 Offset 取值为 CONSUME_FROM_TIMESTAMP 时,该参数有效。

1664591760
GroupIdstring

消息队列 RocketMQ 版的 Group ID。

GID-test
InstanceTypestring

实例类型。只能填写 CLOUD_4(云上 4.0 实例)、CLOUD_5(云上 5.0 实例)和 SELF_BUILT(自建 MQ)。

CLOUD_5
InstanceNetworkstring

实例网络。

PublicNetwork
InstanceVpcIdstring

专有网络 VPC 的 ID。

vpc-***
InstanceVSwitchIdsstring

交换机 ID。

vsw-bp1iu***
InstanceSecurityGroupIdstring

安全组 ID。

eb-167adad548***
AuthTypestring

ACL 或者不填。

ACL
InstanceEndpointstring

实例接入点。

registry-vpc.cn-hangzhou.aliyuncs.com
InstanceUsernamestring

实例用户名。

root
InstancePasswordstring

实例密码。

***
SourceRabbitMQParametersobject

请求参数 SourceRabbitMQParameters。

RegionIdstring

消息队列 RabbitMQ 版实例所在的地域。

cn-hangzhou
InstanceIdstring

消息队列 RabbitMQ 版的实例的 ID。更多信息,请参见使用限制

bastionhost-cn-0ju2x28fj07
VirtualHostNamestring

消息队列 RabbitMQ 版实例的 Vhost 的名称。更多信息,请参见使用限制

eb-connect
QueueNamestring

消息队列 RabbitMQ 版实例的 Queue 的名称。更多信息,请参见使用限制

file-upload-queue
SourceSLSParametersobject

请求参数 SourceSLSParameters。

Projectstring

日志服务 SLS 的日志项目。

VideoTestProject
LogStorestring

日志服务 SLS 的日志库。

cloudfirewall-logstore
ConsumePositionstring

起始消费位点,可以选择最早或最新位点,分别对应“begin”,“end”,也可以从指定时间开始消费,以秒为单位。

end
RoleNamestring

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。此角色权限策略可参考自定义事件源日志服务 SLS。

testRole
SourceHttpEventParametersobject

请求参数 SourceHttpEventParameters。

Typestring

生成的 Webhook 支持的协议类型。取值说明如下:

  • HTTP

  • HTTPS

  • HTTP&HTTPS

HTTPS
Methodarray

生成的 Webhook 支持的 HTTP 请求方法。可多选,可选范围如下:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

  • HEAD

  • OPTIONS

  • TRACE

  • CONNECT

methodstring

生成的 Webhook 支持的 HTTP 请求方法。可多选,可选范围如下:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

  • HEAD

  • OPTIONS

  • TRACE

  • CONNECT

GET
SecurityConfigstring

选择安全配置的类型。可选范围如下:

  • none:无需配置。

  • ip:IP 网段。

  • referer:安全域名。

none
Iparray

IP 网段安全配置。仅在 SecurityConfig 取值为 ip 时,需要设置该参数。可填写 IP 地址段或 IP 地址。

ipstring

IP 网段安全配置。仅在 SecurityConfig 取值为 ip 时,需要设置该参数。可填写 IP 地址段或 IP 地址。

8.212.139.16/32
Refererarray

安全域名配置。仅在 SecurityConfig 取值为 referer 时,需要设置该参数。可填写域名。

refererstring

安全域名配置。仅在 SecurityConfig 取值为 referer 时,需要设置该参数。可填写域名。

aliyundoc.com
PublicWebHookUrlarray

公网请求 URL。

publicWebHookUrlstring

公网请求 URL。

http://***.eventbridge.cn-hangzhou.aliyuncs.com/webhook/putEvents?token=***
VpcWebHookUrlarray

内网请求 URL。

vpcWebHookUrlstring

内网请求 URL。

http://***.eventbridge.cn-hangzhou-vpc.aliyuncs.com/webhook/putEvents?token=0f6705c9253540e1a53e06db011a25b52068562ca50d4818828fffd61c5af***
SourceKafkaParametersobject

Kafka 事件源参数。

InstanceIdstring

实例 ID。

i-2ze6kiwzkebf04s5h8ds
ConsumerGroupstring

订阅该 Topic 的消费者所对应的 Group ID。

test-gid
Topicstring

主题名称。

topic_api_1674441611897
OffsetResetstring

消费位点。

earliest
RegionIdstring

地域 ID。

cn-hangzhou
MaximumTasksinteger

并发配额(消费者数)。

2
Networkstring

网络配置 :Default(默认网络)和 PublicNetwork(自建网络)。

Default
SecurityGroupIdstring

安全组 ID。

sg-f8zatts5g97x0j***
VpcIdstring

VPC ID。

vpc-bp1kz3ohhzgrau2***
VSwitchIdsstring

交换机 ID。

vsw-bp1hcrxq3mkcik***e
SourceScheduledEventParametersobject

时间事件源参数。

Schedulestring

Cron 表达式

0 1 * * * *
TimeZonestring

Cron 执行时区。

GMT+0:00
UserDatastring

JSON 字符串

{"a": "b"}
Codestring

接口返回码:

  • Success:表示成功。

  • 其它:表示错误码。错误码详情,请参见错误码。

Success
Successboolean

操作成功返回 true。

true

返回示例 : `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错误码错误信息
403ServiceNotEnableService not enable

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-02-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-10-19OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-08-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-08-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-07-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-04-21OpenAPI 错误码发生变更查看变更详情