使用ListUserDefinedEventSources API查詢所有外來事件源-事件匯流排-阿里雲

查詢所有外來事件源。

介面說明

查詢所有外來事件源。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
NamePrefix	string	否	事件來源名稱。	testName
EventBusName	string	否	事件匯流排名稱。	testBus
Limit	integer	否	限定每次返回的最大條數，可以和 NextToken 搭配使用實現翻頁能力。注意每次返回的最大條數不超過 100。	50
NextToken	string	否	當指定 Limit 時，如果還有多餘的傳回值則會返回 NextToken。	100

返回參數

名稱	類型	描述	樣本值
	object
Message	string	錯誤資訊。	InvalidArgument
RequestId	string	阿里雲為該請求產生的唯一識別碼。	5169654A-7059-57E3-BFD9-33C7E012****
Data	object	返回資料。
NextToken	string	當指定 Limit 時，如果還有多餘的傳回值則會返回 NextToken。	100
Total	integer	總條數	18
EventSourceList	array<object>	事件來源列表。
	array<object>	事件來源資料結構。
Name	string	查詢到的事件來源的名稱。	rocketmq.source
Arn	string	查詢到的事件來源在阿里雲上的統一資源標識（ARN）。	acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
Status	string	查詢到的事件來源的狀態。取值說明如下： Activated：啟用狀態	Activated
Type	string	查詢到的事件來源的類型。取值說明如下： UserDefined：外來事件源	UserDefined
Ctime	number	建立時間戳記。	1607071602000
ExternalSourceType	string	事件來源類型。	RabbitMQ
EventBusName	string	事件匯流排的名稱。	test-custom-bus
SourceMNSParameters	object	輕量訊息佇列（原 MNS）事件來源參數。
RegionId	string	輕量訊息佇列（原 MNS）的隊列所在的地區。	cn-hangzhou
QueueName	string	輕量訊息佇列（原 MNS）的 Queue 的名稱。	queue.openapi-sign-callback
IsBase64Decode	boolean	是否開啟 Base64 解碼。預設為勾選，即開啟 Base64 解碼。	true
SourceRocketMQParameters	object	請求參數 SourceRocketMQParameters。
RegionId	string	訊息佇列 RocketMQ 版的執行個體所屬地區。	cn-shenzhen
InstanceId	string	訊息佇列 RocketMQ 版的執行個體 ID。更多資訊，請參見使用限制。	bastionhost-cn-7mz293s9d1p
Topic	string	訊息佇列 RocketMQ 版執行個體的 Topic 名稱。更多資訊，請參見使用限制。	migration_instance
Tag	string	訊息的過濾標籤。	dataact
Offset	string	訊息的消費位點。取值說明如下： CONSUME_FROM_LAST_OFFSET：從最新位點開始消費。 CONSUME_FROM_FIRST_OFFSET：從最早位點開始消費。 CONSUME_FROM_TIMESTAMP：從指定時間點的位點開始消費。預設值：CONSUME_FROM_LAST_OFFSET。	CONSUMEFROMLASTOFFSET
Timestamp	number	時間戳記。僅當參數 Offset 取值為 CONSUME_FROM_TIMESTAMP 時，該參數有效。	1664591760
GroupId	string	訊息佇列 RocketMQ 版的 Group ID。	GID-test
InstanceType	string	執行個體類型。只能填寫 CLOUD_4（雲上 4.0 執行個體）、CLOUD_5（雲上 5.0 執行個體）和 SELF_BUILT（自建 MQ）。	CLOUD_5
InstanceNetwork	string	執行個體網路。	PublicNetwork
InstanceVpcId	string	Virtual Private Cloud 的 ID。	vpc-***
InstanceVSwitchIds	string	交換器 ID。	vsw-bp1iu***
InstanceSecurityGroupId	string	安全性群組 ID。	eb-167adad548***
AuthType	string	ACL 或者不填。	ACL
InstanceEndpoint	string	執行個體存取點。	registry-vpc.cn-hangzhou.aliyuncs.com
InstanceUsername	string	執行個體使用者名稱。	root
InstancePassword	string	執行個體密碼。	***
SourceRabbitMQParameters	object	請求參數 SourceRabbitMQParameters。
RegionId	string	訊息佇列 RabbitMQ 版執行個體所在的地區。	cn-hangzhou
InstanceId	string	訊息佇列 RabbitMQ 版的執行個體的 ID。更多資訊，請參見使用限制。	bastionhost-cn-0ju2x28fj07
VirtualHostName	string	訊息佇列 RabbitMQ 版執行個體的 Vhost 的名稱。更多資訊，請參見使用限制。	eb-connect
QueueName	string	訊息佇列 RabbitMQ 版執行個體的 Queue 的名稱。更多資訊，請參見使用限制。	file-upload-queue
SourceSLSParameters	object	請求參數 SourceSLSParameters。
Project	string	Log Service SLS 的記錄項目。	VideoTestProject
LogStore	string	Log Service SLS 的日誌庫。	cloudfirewall-logstore
ConsumePosition	string	起始消費位點，可以選擇最早或最新位點，分別對應“begin”，“end”，也可以從指定時間開始消費，以秒為單位。	end
RoleName	string	授權事件匯流排 EventBridge 使用此角色讀取 SLS 日誌內容時，需滿足條件：在 RAM 控制台建立服務所使用的角色時，需要選擇“阿里雲服務”，並且“受信服務”需要選擇“事件匯流排”。此角色權限原則可參考自訂事件來源Log Service SLS。	testRole
SourceHttpEventParameters	object	請求參數 SourceHttpEventParameters。
Type	string	產生的 Webhook 支援的協議類型。取值說明如下： HTTP HTTPS HTTP&HTTPS	HTTPS
Method	array	產生的 Webhook 支援的 HTTP 要求方法。可多選，可選範圍如下： GET POST PUT PATCH DELETE HEAD OPTIONS TRACE CONNECT
	string	產生的 Webhook 支援的 HTTP 要求方法。可多選，可選範圍如下： GET POST PUT PATCH DELETE HEAD OPTIONS TRACE CONNECT	GET
SecurityConfig	string	選擇安全配置的類型。可選範圍如下： none：無需配置。 ip：IP 網段。 referer：安全網域名稱。	none
Ip	array	IP 網段安全配置。僅在 SecurityConfig 取值為 ip 時，需要設定該參數。可填寫 IP 位址段或 IP 位址。
	string	IP 網段安全配置。僅在 SecurityConfig 取值為 ip 時，需要設定該參數。可填寫 IP 位址段或 IP 位址。	8.212.139.16/32
Referer	array	安全網域名稱配置。僅在 SecurityConfig 取值為 referer 時，需要設定該參數。可填寫網域名稱。
	string	安全網域名稱配置。僅在 SecurityConfig 取值為 referer 時，需要設定該參數。可填寫網域名稱。	aliyundoc.com
PublicWebHookUrl	array	公網請求 URL。
	string	公網請求 URL。	http://*.eventbridge.cn-hangzhou.aliyuncs.com/webhook/putEvents?token=*
VpcWebHookUrl	array	內網請求 URL。
	string	內網請求 URL。	http://*.eventbridge.cn-hangzhou-vpc.aliyuncs.com/webhook/putEvents?token=0f6705c9253540e1a53e06db011a25b52068562ca50d4818828fffd61c5af*
SourceKafkaParameters	object	Kafka 事件來源參數。
InstanceId	string	執行個體 ID。	i-2ze6kiwzkebf04s5h8ds
ConsumerGroup	string	訂閱該 Topic 的消費者所對應的 Group ID。	test-gid
Topic	string	主題名稱。	topic_api_1674441611897
OffsetReset	string	消費位點。	earliest
RegionId	string	地區 ID。	cn-hangzhou
MaximumTasks	integer	並發配額（消費者數）。	2
Network	string	網路設定：Default（預設網路）和 PublicNetwork（自建網路）。	Default
SecurityGroupId	string	安全性群組 ID。	sg-f8zatts5g97x0j***
VpcId	string	VPC ID。	vpc-bp1kz3ohhzgrau2***
VSwitchIds	string	交換器 ID。	vsw-bp1hcrxq3mkcik***e
SourceScheduledEventParameters	object	時間事件源參數。
Schedule	string	Cron 運算式	0 1 * * * *
TimeZone	string	Cron 執行時區。	GMT+0:00
UserData	string	JSON 字串	{"a": "b"}
SourceOSSEventParameters	object
EventTypes	array
	string
StsRoleArn	string
MatchRules	any
Code	string	介面返回碼： Success：表示成功。其它：表示錯誤碼。錯誤碼詳情，請參見錯誤碼。	Success
Success	boolean	操作成功返回 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\"}"
        },
        "SourceOSSEventParameters": {
          "EventTypes": [
            ""
          ],
          "StsRoleArn": "",
          "MatchRules": ""
        }
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	ServiceNotEnable	Service not enable

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。