イベントストリームを作成します。
URL
/eventstreaming/createEventStreaming
使用上の注意
- イベントストリームでは、SourceMNSParameters、SourceRocketMQParameters、SourceRabbitMQParameters、SourceSLSParameters パラメーターのいずれか 1 つのみが返されます。
- イベントストリームでは、SinkMNSParameters、SinkRocketMQParameters、SinkRabbitMQParameters、SinkSLSParameters パラメーターのいずれか 1 つのみを指定できます。
使用上の注意
| パラメーター | タイプ | 必須 | 例 | 説明 |
| EventStreamingName | String | はい | myeventstreaming | イベントストリームの名前。 |
| Description | String | はい | rocketmq2mns | イベントストリームの説明。 |
| Source | Object | はい | SourceRocketMQParameters | イベントプロバイダー。 |
| SourceMNSParameters | Object | いいえ | イベントプロバイダーがシンプルメッセージキュー(旧MNS)であることを指定します。詳細については、「リクエストパラメーター SourceMNSParameters」をご参照ください。 | |
| SourceRocketMQParameters | Object | いいえ | イベントプロバイダーがRocketMQ for ApsaraMQであることを指定します。詳細については、「リクエストパラメーター SourceRocketMQParameters」をご参照ください。 | |
| SourceRabbitMQParameters | Object | いいえ | イベントプロバイダーがRabbitMQ for ApsaraMQであることを指定します。詳細については、「リクエストパラメーター SourceRabbitMQParameters」をご参照ください。 | |
| SourceSLSParameters | Object | いいえ | イベントプロバイダーがログサービスであることを指定します。詳細については、「リクエストパラメーター SinkSLSParameters」をご参照ください。 | |
| FilterPattern | String | いいえ | None. | イベントをフィルタリングするために使用されるルール。このパラメーターを空のままにすると、すべてのイベントが一致となります。 |
| Sink | Object | はい | SinkMNSParameters | イベントターゲット。 |
| SinkMNSParameters | Object | いいえ | イベントターゲットがシンプルメッセージキュー(旧MNS)であることを指定します。詳細については、「リクエストパラメーター SinkMNSParameters」をご参照ください。 | |
| SinkRocketMQParameters | Object | いいえ | イベントターゲットがRocketMQ for ApsaraMQであることを指定します。詳細については、「リクエストパラメーター SinkRocketMQParameters」をご参照ください。 | |
| SinkRabbitMQParameters | Object | いいえ | イベントターゲットがRabbitMQ for ApsaraMQであることを指定します。詳細については、「リクエストパラメーター SinkRabbitMQParameters」をご参照ください。 | |
| SinkSLSParameters | Object | いいえ | イベントターゲットがログサービスであることを指定します。詳細については、「リクエストパラメーター SinkSLSParameters」をご参照ください。 | |
| RunOptions | Object | いいえ | ランタイム環境。 | |
| RetryStrategy | String | はい | BACKOFF_RETRY | イベントのプッシュに失敗した場合に使用される再試行ポリシー。有効な値:
デフォルト値:BACKOFF_RETRY。 |
| ErrorsTolerance | String | はい | ALL | フォールトトレランスポリシー。このポリシーは、エラーが発生した場合にエラーを無視するかどうかを指定します。有効な値:
デフォルト値:ALL。 |
| DeadLetterQueue | Object | はい | デッドレターキューを有効にするかどうかを指定します。デフォルトでは、デッドレターキューは無効になっています。再試行ポリシーで指定された許容回数後にプッシュに失敗したメッセージは破棄されます。 | |
| Arn | String | いいえ | acs:mq:cn-chengdu:164901546557****:/instances/MQ_INST_164901546557****_BXxk0KXx/topic/Mytopic | RabbitMQ for ApsaraMQ インスタンストピックのAlibaba Cloud Resource Name(ARN)。 |
リクエストパラメーター SourceMNSParameters
SourceMNSParameters パラメーターを指定する場合、次の表に示すパラメーターを設定できます。
| パラメーター | タイプ | 必須 | 例 | 説明 |
| QueueName | String | はい | demo | Simple Message Queue(旧称 MNS) インスタンス内のキューの名前。 |
| IsBase64Decode | String | はい | true | Base64 エンコーディングを有効にするかどうかを指定します。デフォルト値:true。 |
リクエストパラメータ SourceRocketMQParameters
SourceRocketMQParameters パラメータを指定する場合、次の表に示すパラメータを設定できます。
| パラメータ | タイプ | 必須 | 例 | 説明 |
| RegionId | String | はい | cn-hangzhou | RocketMQ for ApsaraMQ インスタンスが存在するリージョンの ID です。 |
| InstanceId | String | はい | MQ_INST_164901546557****_BAAN**** | RocketMQ for ApsaraMQ インスタンスの ID です。詳細については、「制限」をご参照ください。 |
| Topic | String | はい | mytopic | RocketMQ for ApsaraMQ インスタンスのトピック名です。詳細については、「制限」をご参照ください。 |
| Tag | String | いいえ | test | メッセージをフィルタリングするために使用されるタグです。 |
| Offset | String | いいえ | CONSUME_FROM_TIMESTAMP | メッセージのコンシューマオフセットです。有効な値:
デフォルト値: CONSUME_FROM_LAST_OFFSET です。 |
| Timestamp | Long | いいえ | 1636597951964 | 消費を開始するオフセットのタイムスタンプです。このパラメータは、Offset パラメータを CONSUME_FROM_TIMESTAMP に設定した場合にのみ有効です。 |
| GroupID | String | はい | GID_group1 | RocketMQ for ApsaraMQ インスタンスのグループ ID です。 |
リクエストパラメータ SourceRabbitMQParameters
SourceRabbitMQParameters パラメータを指定する場合、次の表に示すパラメータを設定できます。
| パラメータ | タイプ | 必須 | 例 | 説明 |
| InstanceId | String | はい | amqp-cn-nif22u74**** | ApsaraMQ for RabbitMQ インスタンスの ID です。詳細については、「制限」をご参照ください。 |
| VirtualHostName | String | はい | eb-connect | ApsaraMQ for RabbitMQ インスタンスの vhost の名前です。詳細については、「制限」をご参照ください。 |
| QueueName | String | はい | demo | ApsaraMQ for RabbitMQ インスタンスのキューの名前です。詳細については、「制限」をご参照ください。 |
リクエストパラメーター SourceSLSParameters
SourceMNSParameters パラメーターを指定する場合、次の表に示すパラメーターを設定できます。
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Project | String | はい | test-project | ログサービス プロジェクト。 |
| LogStore | String | はい | test-logstore | ログサービス ログストア。 |
| ConsumePosition | String | いいえ | end | 開始コンシューマー オフセット。値 begin は最も古いオフセットを示し、値 end は最新のオフセットを示します。消費を開始する時間を秒単位で指定することもできます。 |
| RoleName | String | はい | testRole | ロールの名前。EventBridge がこのロールを使用してログサービスのログを読み取ることを承認するには、RAMコンソールでロールを作成するときに、[選択された信頼できるエンティティ] パラメーターで [Alibaba Cloud サービス] を選択し、[信頼できるサービスの選択] パラメーターで [EventBridge] を選択する必要があります。このロールの権限ポリシーについては、シンプルなログサービス タイプのカスタムイベントソースを作成する を参照してください。 |
リクエストパラメーター SinkMNSParameters
SinkMNSParameters パラメーターを指定すると、次の表に示すパラメーターを設定できます。
| パラメーター | タイプ | 必須 | 例 | 説明 |
| QueueName | TargetParameter | はい | イベントターゲットが シンプルメッセージキュー(旧称 MNS) の場合に指定するキューの名前。 | |
| Value | String | はい | MyQueue | シンプルメッセージキュー(旧称 MNS) インスタンス内のキューの名前。 |
| Form | String | いいえ | CONSTANT | 変換方法。デフォルト値:CONSTANT。 |
| Body | TargetParameter | いいえ | メッセージの内容。 | |
| Form | String | いいえ | TEMPLATE | 変換方法。 |
| Value | String | はい | | 変換前の値。 |
| Template | String | いいえ | The value of ${key} is ${value}! | イベントを変換するためのテンプレート。 |
| IsBase64Encode | TargetParameter | はい | Base64 エンコードを有効にするかどうかを指定します。 | |
| Value | String | はい | true | Base64 エンコードを有効にします。 |
| Form | String | いいえ | CONSTANT | 変換方法。デフォルト値:CONSTANT。 |
リクエストパラメーターSinkRocketMQ パラメーター
SinkRocketMQParameters パラメーターを指定する場合、次の表に示すパラメーターを構成できます。
| パラメーター | タイプ | 必須 | 例 | 説明 |
| インスタンス ID | TargetParameter | はい | イベントターゲットが ApsaraMQ for RocketMQ の場合に指定するインスタンスの ID です。 | |
| 値 | String | はい | MQ_INST_164901546557****_BAAN**** | ApsaraMQ for RocketMQ インスタンスの ID です。詳細については、「制限」をご参照ください。 |
| 形式 | String | いいえ | CONSTANT | 変換方法。既定値: CONSTANT です。 |
| トピック | TargetParameter | はい | ApsaraMQ for RocketMQ インスタンスのトピックです。 | |
| 値 | String | はい | Mytopic | ApsaraMQ for RocketMQ インスタンスのトピック名です。詳細については、「制限」をご参照ください。 |
| 形式 | String | いいえ | CONSTANT | 変換方法。デフォルト値: CONSTANT です。 |
| 本文 | TargetParameter | はい | メッセージの内容。 | |
| フォーム | 文字列 | いいえ | いいえ | TEMPLATE |
| 値 | 文字列 | はい | | 変換前の値。 |
| テンプレート | String | はい | ${key} の値は ${value} です! | イベントの変換に使用するテンプレート。 |
| プロパティ | TargetParameter | はい | メッセージのフィルタリングに使用されるプロパティです。 | |
| 値 | 文字列 | はい | | 変換前の値。 |
| 形式 | String | いいえ | TEMPLATE | 変換方法です。 |
| テンプレート | String | はい | ${key} の値は ${value} です! | イベントの変換に使用されるテンプレート。 |
| キー | TargetParameter | はい | メッセージのフィルタリングに使用されるプロパティです。 | |
| 値 | 文字列 | はい | | 変換前の値。 |
| 形式 | String | いいえ | TEMPLATE | 変換方法。 |
| テンプレート | String | はい | ${key} の値は ${value} です! | イベントの変換に使用されるテンプレート。 |
| タグ | TargetParameter | はい | メッセージのフィルタリングに使用するプロパティです。 | |
| 値 | String | はい | | 変換前の値。 |
| フォーム | String | はい | myeventstreaming | イベントストリームの名前。 |
| テンプレート | 文字列 | はい | ${key} の値は ${value} です! |
リクエストパラメータ SinkRabbitMQParameters
SinkRabbitMQParameters パラメータを指定する場合、次の表に示すパラメータを設定できます。
| パラメータ | タイプ | 必須 | 例 | 説明 |
| InstanceId | TargetParameter | はい | イベントターゲットが ApsaraMQ for RabbitMQ の場合に指定するインスタンスの ID です。 | |
| Value | String | はい | amqp-cn-2r42e73o**** | ApsaraMQ for RabbitMQ インスタンスの ID です。詳細については、「制限」をご参照ください。 |
| Form | String | いいえ | CONSTANT | 変換方法。デフォルト値:CONSTANT。 |
| VirtualHostName | TargetParameter | はい | ApsaraMQ for RabbitMQ インスタンスの vhost の名前です。 | |
| Value | String | はい | rabbit-host | ApsaraMQ for RabbitMQ インスタンスの vhost の名前です。詳細については、「制限」をご参照ください。 |
| Form | String | いいえ | CONSTANT | 変換方法。デフォルト値:CONSTANT。 |
| TargetType | TargetParameter | はい | イベントのプッシュ先リソースのタイプです。 | |
| Value | String | はい | Exchange/Queue | イベントのプッシュ先リソースのタイプです。有効な値:
|
| Form | String | いいえ | CONSTANT | 変換方法。デフォルト値:CONSTANT。 |
| Exchange | TargetParameter | はい | 宛先インスタンスでイベントのプッシュ先となる交換の名前です。 TargetType パラメータを Exchange に設定した場合にのみ、このパラメータは有効です。 | |
| Value | String | はい | a_exchange | ApsaraMQ for RabbitMQ インスタンスの交換の名前です。詳細については、「制限」をご参照ください。 |
| Form | String | いいえ | CONSTANT | 変換方法。デフォルト値:CONSTANT。 |
| RoutingKey | TargetParameter | はい | メッセージのルーティングルールです。 TargetType パラメータを Exchange に設定した場合にのみ、このパラメータは有効です。 | |
| Value | String | はい | housekeeping | メッセージのルーティングルールです。 |
| Form | String | いいえ | CONSTANT | 変換方法。デフォルト値:CONSTANT。 |
| QueueName | TargetParameter | はい | 宛先インスタンスでイベントのプッシュ先となるキューの名前です。 TargetType パラメータを Queue に設定した場合にのみ、このパラメータは有効です。 | |
| Value | String | はい | MyQueue | Message Queue for RabbitMQ インスタンスのキューの名前です。詳細については、「制限」をご参照ください。 |
| Form | String | いいえ | CONSTANT | 変換方法。デフォルト値:CONSTANT。 |
| Body | TargetParameter | はい | メッセージの内容。 | |
| Form | String | いいえ | TEMPLATE | 変換方法。 |
| Value | String | はい | | 変換前の値。 |
| Template | String | いいえ | The value of ${key} is ${value}! | イベントの変換に使用されるテンプレート。 |
| MessageId | TargetParameter | はい | メッセージの ID。 | |
| Value | String | はい | | 変換前の値。 |
| Form | String | いいえ | TEMPLATE | 変換方法。 |
| Template | String | はい | The value of ${key} is ${value}! | イベントの変換に使用されるテンプレート。 |
| Properties | TargetParameter | はい | メッセージのフィルタリングに使用されるタグ。 | |
| Value | String | はい | | 変換前の値。 |
| Form | String | いいえ | TEMPLATE | 変換方法。 |
| Template | String | はい | The value of ${key} is ${value}! | イベントの変換に使用されるテンプレート。 |
リクエストパラメータ SinkSLSParameters
SinkRabbitMQParameters パラメータを指定する場合、次の表に示すパラメータを設定できます。
| パラメータ | タイプ | 必須 | 例 | 説明 |
| Project | String | はい | test-project | Log Service プロジェクト。 |
| LogStore | String | はい | test-logstore | Log Service Logstore。 |
| Topic | String | いいえ | testTopic | ログが存在するトピック。このパラメータの値は、Log Service の予約フィールド "__topic__" の値と同じです。 |
| RoleName | String | はい | testRole | ロール名。EventBridge がこのロールを使用して Log Service のログを読み取ることを承認するには、RAM コンソールでロールを作成するときに、[選択された信頼できるエンティティ] パラメータで [Alibaba Cloud サービス] を選択し、[信頼できるサービスの選択] パラメータで [EventBridge] を選択する必要があります。 |
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| EventStreamingARN | String | acs:eventbridge:cn-hangzhou:164901546557****:eventstreaming/myeventstreaming | EventStreaming の ARN です。 |
例
以下のサンプルリクエストとレスポンスでは、ApsaraMQ for RocketMQ タイプのカスタムイベントソースから、イベントターゲット Simple Message Queue (旧称 MNS) にイベントがルーティングされます。
サンプルリクエスト
POST /eventstreaming/creatEventStreaming HTTP/1.1
Host: 164901546557****.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
{
"EventStreamingName":"myeventstreaming",
"Description":"rocketmq2mns",
"FilterPattern":"{}",
"Source":{
"SourceRocketMQParameters":{
"InstanceId":"MQ_INST_164901546557****_BAAN****",
"GroupID":"GID_group1",
"Topic":"mytopic",
"Offset":"CONSUME_FROM_TIMESTAMP",
"Tag":"",
"RegionId":"cn-hangzhou",
"Timestamp":1636597951964
}
},
"Sink":{
"SinkMNSParameters":{
"QueueName":{
"Value":"MyQueue",
"Form":"CONSTANT"
},
"IsBase64Encode":{
"Value":"true",
"Form":"CONSTANT"
},
"Body":{
"Value":{
"key":"value"
},
"Form":"TEMPLATE",
"Template":"The value of ${key} is ${value}!"
}
}
},
"RunOptions":{
"ErrorsTolerance":"ALL",
"RetryStrategy":{
"PushRetryStrategy":"BACKOFF_RETRY"
},
"DeadLetterQueue":{
"Arn":"acs:mq:cn-chengdu:164901546557****:/instances/MQ_INST_164901546557****_BXxk0KXx/topic/Mytopic"
}
}
}サンプルレスポンス
HTTP/1.1 200 OK
Server: AliyunEventBridge
Connection: keep-alive
Content-Type: application/json;charset=utf-8
Content-Length: 79
x-eventbridge-request-id: 244BED53-719A-15D7-B7F9-1C404273****
Date: Sat, 18 Apr 2020 05:30:41 GMT
{
"code":"200",
"data":{
"RequestId":"244BED53-719A-15D7-B7F9-1C404273****",
"Data":{
"EventStreamingARN":"acs:eventbridge:cn-hangzhou:164901546557****:eventstreaming/myeventstreaming"
},
"Code":"Success",
"Success":true
},
"httpStatusCode":"200",
"requestId":"244BED53-719A-15D7-B7F9-1C404273****",
"successResponse":true
}