イベントストリームに関する情報 (基本情報、イベントソース、イベントルール、イベントターゲットに関する情報など) を変更します。
URL
/eventstreaming/updateEventStreaming
使用上の注意
- イベントストリームでは、SourceMNSParameters、SourceRocketMQParameters、SourceRabbitMQParameters、SourceSLSParameters パラメーターのいずれか 1 つのみが返されます。
- イベントストリームでは、SinkMNSParameters、SinkRocketMQParameters、SinkRabbitMQParameters、SinkSLSParameters パラメーターのいずれか 1 つのみを指定できます。
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| EventStreamingName | String | はい | myeventstreaming | イベントストリームの名前。 |
| Description | String | はい | rocketmq2mns | イベントストリームの説明。 |
| Source | Object | はい | SourceRocketMQParameters | イベントプロバイダー。 |
| SourceMNSParameters | Object | いいえ | イベントプロバイダーが Simple Message Queue (旧称 MNS) であることを指定します。 詳細については、リクエストパラメーター SourceMNSParameters をご参照ください。 | |
| SourceRocketMQParameters | Object | いいえ | イベントプロバイダーが RocketMQ for ApsaraMQ であることを指定します。 詳細については、リクエストパラメーター SourceRocketMQParameters をご参照ください。 | |
| SourceRabbitMQParameters | Object | いいえ | イベントプロバイダーが RabbitMQ for ApsaraMQ であることを指定します。 詳細については、リクエストパラメーター SourceRabbitMQParameters をご参照ください。 | |
| SourceSLSParameters | Object | いいえ | イベントプロバイダーがログサービスであることを指定します。 詳細については、リクエストパラメーター SinkSLSParameters をご参照ください。 | |
| FilterPattern | String | いいえ | なし | イベントをフィルタリングするために使用されるルール。 このパラメーターを空のままにすると、すべてのイベントが一致しま す。 |
| Sink | Object | はい | SinkMNSParameters | イベントターゲット。 |
| SinkMNSParameters | Object | いいえ | イベントターゲットが Simple Message Queue (旧称 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**** | RabbitMQ for ApsaraMQ インスタンスの ID。 詳細については、制限 をご参照ください。 |
| VirtualHostName | String | はい | eb-connect | RabbitMQ for ApsaraMQ インスタンスの vhost の名前。 詳細については、制限 をご参照ください。 |
| QueueName | String | はい | demo | RabbitMQ for ApsaraMQ インスタンスのキューの名前。 詳細については、制限 をご参照ください。 |
リクエストパラメーター SourceSLSParameters
SourceMNSParameters パラメーターを指定する場合は、次の表に示すパラメーターを設定できます。
| パラメーター | タイプ | 必須 | 例 | 説明 |
| RoleName | String | はい | testRole | ロールの名前。 EventBridge がこのロールを使用してログサービスのログを読み取ることを承認するには、RAM コンソールでロールを作成するときに、[選択された信頼できるエンティティ] パラメーターで [Alibaba Cloud サービス] を選択し、[信頼できるサービスの選択] パラメーターで [EventBridge] を選択する必要があります。 |
リクエストパラメーター SinkMNSParameters
SinkMNSParameters パラメーターを指定する場合は、次の表に示すパラメーターを設定できます。
| パラメーター | タイプ | 必須 | 例 | 説明 |
| QueueName | TargetParameter | はい | イベントターゲットが Simple Message Queue (旧称 MNS) の場合に指定するキューの名前。 | |
| Value | String | はい | MyQueue | Simple Message Queue (旧称 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。 |
リクエストパラメーター SinkRocketMQParameters
SinkRocketMQParameters パラメーターを指定する場合は、次の表に示すパラメーターを設定できます。
| パラメーター | タイプ | 必須 | 例 | 説明 |
| InstanceId | TargetParameter | はい | イベントターゲットが RocketMQ for ApsaraMQ の場合に指定するインスタンスの ID。 | |
| Value | String | はい | MQ_INST_164901546557****_BAAN**** | RocketMQ for ApsaraMQ インスタンスの ID。 詳細については、制限 をご参照ください。 |
| Form | String | いいえ | CONSTANT | 変換方法。 デフォルト値: CONSTANT。 |
| Topic | TargetParameter | はい | RocketMQ for ApsaraMQ インスタンスのトピック。 | |
| Value | String | はい | Mytopic | RocketMQ for ApsaraMQ インスタンスのトピックの名前。 詳細については、制限 をご参照ください。 |
| Form | String | いいえ | CONSTANT | 変換方法。 デフォルト値: CONSTANT。 |
| Body | TargetParameter | はい | メッセージの内容。 | |
| Form | String | いいえ | No | TEMPLATE |
| Value | String | はい | | 変換前の値。 |
| Template | String | はい | The value of ${key} is ${value}! | イベントを変換するためのテンプレート。 |
| Properties | TargetParameter | はい | メッセージのフィルタリングに使用されるプロパティ。 | |
| Value | String | はい | | 変換前の値。 |
| Form | String | いいえ | TEMPLATE | 変換方法。 |
| Template | String | はい | The value of ${key} is ${value}! | イベントを変換するためのテンプレート。 |
| Keys | TargetParameter | はい | メッセージのフィルタリングに使用されるプロパティ。 | |
| Value | String | はい | | 変換前の値。 |
| Form | String | いいえ | TEMPLATE | 変換方法。 |
| Template | String | はい | The value of ${key} is ${value}! | イベントを変換するためのテンプレート。 |
| Tags | TargetParameter | はい | メッセージのフィルタリングに使用されるプロパティ。 | |
| Value | String | はい | | 変換前の値。 |
| Form | String | いいえ | TEMPLATE | 変換方法。 |
| Template | String | はい | The value of ${key} is ${value}! | イベントを変換するためのテンプレート。 |
リクエストパラメーター SinkRabbitMQParameters
SinkRabbitMQParameters パラメーターを指定する場合は、次の表に示すパラメーターを設定できます。
| パラメーター | タイプ | 必須 | 例 | 説明 |
| InstanceId | TargetParameter | はい | イベントターゲットが RabbitMQ for ApsaraMQ の場合に指定するインスタンスの ID。 | |
| Value | String | はい | amqp-cn-2r42e73o**** | RabbitMQ for ApsaraMQ インスタンスの ID。 詳細については、制限 をご参照ください。 |
| Form | String | いいえ | CONSTANT | 変換方法。 デフォルト値: CONSTANT。 |
| VirtualHostName | TargetParameter | はい | RabbitMQ for ApsaraMQ インスタンスの vhost の名前。 | |
| Value | String | はい | rabbit-host | RabbitMQ for ApsaraMQ インスタンスの vhost の名前。 詳細については、制限 をご参照ください。 |
| Form | String | いいえ | CONSTANT | 変換方法。 デフォルト値: CONSTANT。 |
| TargetType | TargetParameter | はい | イベントのプッシュ先のリソースのタイプ。 | |
| Value | String | はい | Exchange/Queue | イベントのプッシュ先のリソースのタイプ。有効な値:
|
| Form | String | いいえ | CONSTANT | 変換方法。 デフォルト値: CONSTANT。 |
| Exchange | TargetParameter | はい | 宛先インスタンスでイベントのプッシュ先の交換の名前。 このパラメーターは、TargetType パラメーターを Exchange に設定した場合にのみ有効です。 | |
| Value | String | はい | a_exchange | RabbitMQ for ApsaraMQ インスタンスの交換の名前。 詳細については、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
SinkSLSParameters パラメーターを指定する場合は、次の表に示すパラメーターを設定できます。
| パラメーター | タイプ | 必須 | 例 | 説明 |
| RoleName | String | はい | testRole | ロールの名前。 EventBridge がこのロールを使用してログサービスのログを読み取ることを承認するには、RAM コンソールでロールを作成するときに、[選択された信頼できるエンティティ] パラメーターで [Alibaba Cloud サービス] を選択し、[信頼できるサービスの選択] パラメーターで [EventBridge] を選択する必要があります。 |
レスポンスパラメーター
イベントストリームの情報が変更された場合、HTTP ステータスコード 200 が返され、レスポンスボディは返されません。
例
以下のサンプルリクエストとレスポンスでは、イベントストリームのイベントターゲットが RabbitMQ for ApsaraMQ に変更されています。
サンプルリクエスト
POST /eventstreaming/updateEventStreaming 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":"rocketmq2rabbitmq", // 説明
"FilterPattern":"{}", // フィルターパターン
"Source":{ // イベントソース
"SourceRocketMQParameters":{ // RocketMQ イベントソースパラメーター
"InstanceId":"MQ_INST_164901546557****_BAAN****", // インスタンスID
"GroupID":"GID_group1", // グループID
"Topic":"mytopic", // トピック名
"Offset":"CONSUME_FROM_LAST_OFFSET", // オフセット
"Tag":"", // タグ
"RegionId":"cn-hangzhou" // リージョンID
}
},
"Sink":{ // イベントターゲット
"SinkRabbitMQParameters":{ // RabbitMQ イベントターゲットパラメーター
"InstanceId":{ // インスタンスID
"Value":"amqp-cn-2r42e73o****", // 値
"Form":"CONSTANT" // 形式
},
"VirtualHostName":{ // 仮想ホスト名
"Value":"dlq", // 値
"Form":"CONSTANT" // 形式
},
"TargetType":{ // ターゲットタイプ
"Value":"Exchange", // 値
"Form":"CONSTANT" // 形式
},
"Exchange":{ // 交換
"Value":"a_exchange", // 値
"Form":"CONSTANT" // 形式
},
"RoutingKey":{ // ルーティングキー
"Value":"housekeeping", // 値
"Form":"JSONPATH" // 形式
},
"Body":{ // メッセージ本文
"Value":"{\n \"key\": \"value\"\n}", // 値
"Form":"TEMPLATE", // 形式
"Template":"The value of ${key} is ${value}." // テンプレート
},
"MessageId":{ // メッセージID
"Value":"message_001", // 値
"Form":"JSONPATH" // 形式
},
"Properties":{ // プロパティ
"Value":"systemProperties", // 値
"Form":"JSONPATH" // 形式
}
}
},
"RunOptions":{ // 実行オプション
"ErrorsTolerance":"ALL", // エラー許容範囲
"RetryStrategy":{ // 再試行戦略
"PushRetryStrategy":"BACKOFF_RETRY" // プッシュ再試行戦略
}
}
}サンプルレスポンス
HTTP/1.1 200 OK
Server: AliyunEventBridge
Connection: keep-alive
Content-Type: application/json;charset=utf-8
Content-Length: 79
x-eventbridge-request-id: D232C031-7CDC-1FEF-BB88-5F4522A8****
Date: Sat, 18 Apr 2020 05:30:41 GMT
{
"code":"200", // コード
"data":{ // データ
"RequestId":"D232C031-7CDC-1FEF-BB88-5F4522A8****", // リクエストID
"Data":true, // データ
"Code":"Success", // コード
"Success":true // 成功
},
"httpStatusCode":"200", // HTTPステータスコード
"requestId":"D232C031-7CDC-1FEF-BB88-5F4522A8****", // リクエストID
"successResponse":true // 成功レスポンス
}