ListUserDefinedEventSources でカスタムイベントソースをクエリ - EventBridge - Alibaba Cloud - EventBridge

この操作は、すべてのカスタムイベントソースを照会します。

操作説明

すべてのカスタムイベントソースを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eventbridge:ListUserDefinedEventSources

get

*EventSource

acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/eventsource/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NamePrefix	string	任意	イベントソース名のプレフィックス。	testName
EventBusName	string	任意	イベントバスの名前。	testBus
Limit	integer	任意	リクエストごとに返すエントリの最大数。このパラメーターを NextToken と共に使用して、ページネーションを実現できます。最大値は 100 です。	50
NextToken	string	任意	次のページの結果を取得するために使用されるトークン。このパラメーターを、前の呼び出しから返された NextToken 値に設定します。	100

レスポンスフィールド

フィールド	型	説明	例
	object
Message	string	エラーメッセージ。	InvalidArgument
RequestId	string	リクエストの一意の ID。Alibaba Cloud によって生成されます。	5169654A-7059-57E3-BFD9-33C7E012****
Data	object	返されたデータ。
NextToken	string	次のページの結果を取得するためのトークン。このパラメーターは、結果が切り捨てられた場合にのみ返されます。	100
Total	integer	エントリの総数。	18
EventSourceList	array<object>	イベントソースのリスト。
	array<object>	イベントソースの詳細。
Name	string	イベントソースの名前。	rocketmq.source
Arn	string	イベントソースの Alibaba Cloud リソース名 (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	Message Service (MNS) イベントソースのパラメーター。
RegionId	string	MNS キューが配置されているリージョン。	cn-hangzhou
QueueName	string	MNS キューの名前。	queue.openapi-sign-callback
IsBase64Decode	boolean	Base64 デコードを有効にするかどうかを指定します。デフォルト値は `true` です。	true
SourceRocketMQParameters	object	ApsaraMQ for RocketMQ イベントソースのパラメーター。
RegionId	string	ApsaraMQ for RocketMQ インスタンスが配置されているリージョン。	cn-shenzhen
InstanceId	string	ApsaraMQ for RocketMQ インスタンスの ID。詳細については、「使用制限」をご参照ください。	bastionhost-cn-7mz293s9d1p
Topic	string	ApsaraMQ for RocketMQ インスタンスのトピック名。詳細については、「使用制限」をご参照ください。	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	ApsaraMQ for RocketMQ インスタンスのグループ ID。	GID-test
InstanceType	string	インスタンスタイプ。このパラメーターは、`CLOUD_4` (ApsaraMQ for RocketMQ 4.0 インスタンス)、`CLOUD_5` (ApsaraMQ for RocketMQ 5.0 インスタンス)、または `SELF_BUILT` (自己管理型 MQ インスタンス) にのみ設定できます。	CLOUD_5
InstanceNetwork	string	インスタンスネットワーク。	PublicNetwork
InstanceVpcId	string	Virtual Private Cloud (VPC) の ID。	vpc-***
InstanceVSwitchIds	string	vSwitch 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	ApsaraMQ for RabbitMQ イベントソースのパラメーター。
RegionId	string	ApsaraMQ for RabbitMQ インスタンスが配置されているリージョン。	cn-hangzhou
InstanceId	string	ApsaraMQ for RabbitMQ インスタンスの ID。詳細については、「使用制限」をご参照ください。	bastionhost-cn-0ju2x28fj07
VirtualHostName	string	ApsaraMQ for RabbitMQ インスタンスのバーチャルホストの名前。詳細については、「使用制限」をご参照ください。	eb-connect
QueueName	string	ApsaraMQ for RabbitMQ インスタンスのキューの名前。詳細については、「使用制限」をご参照ください。	file-upload-queue
SourceSLSParameters	object	Log Service (SLS) イベントソースのパラメーター。
Project	string	Log Service (SLS) プロジェクト。	VideoTestProject
LogStore	string	Log Service (SLS) Logstore。	cloudfirewall-logstore
ConsumePosition	string	開始コンシューマオフセット。`begin` で最も早いオフセット、`end` で最新のオフセット、または特定のタイムスタンプ (秒単位) を指定して消費を開始できます。	end
RoleName	string	EventBridge が Log Service (SLS) からログを読み取るために引き受ける RAM ロールの名前。RAM コンソールでこのロールを作成する際、信頼できるエンティティとして Alibaba Cloud サービスを、信頼できるサービスとして EventBridge を選択します。このロールのアクセスポリシーの詳細については、「Log Service (SLS) のカスタムイベントソース」をご参照ください。	testRole
SourceHttpEventParameters	object	Webhook イベントソースのパラメーター。
Type	string	Webhook がサポートするプロトコルタイプ。有効な値： `HTTP` `HTTPS` `HTTP&HTTPS`	HTTPS
Method	array	Webhook がサポートする HTTP リクエストメソッド。1 つ以上のメソッドを選択できます。有効な値： `GET` `POST` `PUT` `PATCH` `DELETE` `HEAD` `OPTIONS` `TRACE` `CONNECT`
	string	HTTP リクエストメソッド。 GET POST PUT PATCH DELETE HEAD OPTIONS TRACE CONNECT	GET
SecurityConfig	string	セキュリティ設定のタイプ。有効な値： `none`：設定は不要です。 `ip`：IP アドレス範囲。 `referer`：セキュリティドメイン。	none
Ip	array	セキュリティ設定の IP アドレス範囲。このパラメーターは、`SecurityConfig` が `ip` に設定されている場合にのみ必須です。CIDR ブロックまたは IP アドレスを指定できます。
	string	CIDR ブロックまたは IP アドレス。このパラメーターは、`SecurityConfig` が `ip` に設定されている場合にのみ必須です。	8.212.139.16/32
Referer	array	セキュリティドメインの設定。このパラメーターは、`SecurityConfig` が `referer` に設定されている場合にのみ必須です。1 つ以上のドメイン名を指定できます。
	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	Kafka インスタンスの ID。	i-2ze6kiwzkebf04s5h8ds
ConsumerGroup	string	トピックをサブスクライブするコンシューマーグループの ID。	test-gid
Topic	string	トピック名。	topic_api_1674441611897
OffsetReset	string	オフセットが保存されていない場合に消費を開始する位置。例：`earliest`。	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	vSwitch ID。	vsw-bp1hcrxq3mkcik***e
SourceScheduledEventParameters	object	スケジュールされたイベントソースのパラメーター。
Schedule	string	cron 式。	0 1 * * * *
TimeZone	string	cron 式のタイムゾーン。	GMT+0:00
UserData	string	JSON 文字列。	{"a": "b"}
SourceOSSEventParameters	object	Object Storage Service (OSS) イベントソースのパラメーター。
EventTypes	array	イベントタイプのリスト。
	string	イベントタイプ。
StsRoleArn	string	Security Token Service (STS) ロールの ARN。
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 }

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
403	ServiceNotEnable	Service not enable

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。