GetEventStreaming - - Alibaba Cloud ドキュメントセンター

イベントストリームの詳細をクエリします。

URL

/eventstreaming/getEventStreaming

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
EventStreamingName	String	はい	myeventstreaming	詳細をクエリするイベントストリームの名前。

レスポンスパラメータ

パラメータ	タイプ	例	説明
EventStreamingName	String	rocketmq-sync	返されるイベントストリームの名前。
Description	String	RocketMQ-to-RocketMQ	返されるイベントストリームの説明。
Status	String	RUNNING	返されるイベントストリームのステータス。有効な値： READY STARTING STARTING_FAILED RUNNING RUNNING_FAILED PAUSED
Source	Object	SourceRocketMQParameters	イベントプロバイダー。
SourceMNSParameters	Object		イベントプロバイダーが Simple Message Queue (旧称 MNS) であることを示します。
SourceRocketMQParameters	Object		イベントプロバイダーが RocketMQ であることを示します。
SourceRabbitMQParameters	Object		イベントプロバイダーが RabbitMQ であることを示します。
SourceSLSParameters	Object		イベントプロバイダーがログサービスであることを示します。
FilterPattern	Map	なし。	イベントをフィルタリングするために使用されるルール。このパラメータを空のままにすると、すべてのイベントが一致とみなされます。
Sink	Object	SinkRocketMQParameters	イベントターゲット。
SinkMNSParameters	Object		イベントターゲットが Simple Message Queue (旧称 MNS) であることを示します。
SinkRocketMQParameters	Object		イベントターゲットが RocketMQ であることを示します。
SinkRabbitMQParameters	Object		イベントターゲットが RabbitMQ であることを示します。
SinkSLSParameters	Object		イベントターゲットがログサービスであることを示します。
RunOptions	Map		ランタイム環境。
RetryStrategy	String	BACKOFF_RETRY	イベントのプッシュに失敗した場合に使用する再試行ポリシー。有効な値： BACKOFF_RETRY: バックオフ再試行。リクエストは最大 3 回再試行できます。2 回の連続する再試行の間隔は、10 ～ 20 秒のランダムな値です。 EXPONENTIAL_DECAY_RETRY: 指数関数的減衰再試行。リクエストは最大 176 回再試行できます。2 回の連続する再試行の間隔は指数関数的に増加して 512 秒になり、合計再試行時間は 1 日です。具体的な再試行間隔は、1、2、4、8、16、32、64、128、256、512、512、...、512 秒で、合計で最大 167 個の 512 秒が含まれます。
ErrorsTolerance	String	ALL	フォールトトレランスポリシー。このポリシーは、エラーが発生した場合にエラーを無視するかどうかを指定します。有効な値： ALL: エラーを無視します。 NONE: エラーを無視しません。

レスポンスパラメータ SourceMNSParameters

パラメータ	タイプ	例	説明
QueueName	String	demo	Simple Message Queue (旧称 MNS) インスタンスのキューの名前。
IsBase64Decode	String	true	Base64 エンコーディングが有効かどうかを示します。

レスポンスパラメータ SourceRocketMQParameters

パラメータ	タイプ	例	説明
RegionId	String	cn-hangzhou	RocketMQ インスタンスが存在するリージョンの ID。
InstanceId	String	MQ_INST_164901546557**_BAAN**	RocketMQ インスタンスの ID。詳細については、制限をご参照ください。
Topic	String	mytopic	RocketMQ インスタンスのトピックの名前。詳細については、制限をご参照ください。
Tag	String	test	メッセージのフィルタリングに使用されるタグ。
Offset	String	CONSUME_FROM_TIMESTAMP	メッセージのコンシューマオフセット。有効な値： CONSUME_FROM_LAST_OFFSET: 最新のオフセットから消費を開始します。 CONSUME_FROM_FIRST_OFFSET: 最も古いオフセットから消費を開始します。 CONSUME_FROM_TIMESTAMP: 指定された時点のオフセットから消費を開始します。
Timestamp	Long	1636597951964	消費を開始するオフセットのタイムスタンプ。このパラメータは、Offset パラメータを CONSUME_FROM_TIMESTAMP に設定した場合にのみ有効です。
GroupID	String	GID_group1	RocketMQ インスタンスのグループの ID。

レスポンスパラメータ SourceRabbitMQParameters

パラメータ	タイプ	例	説明
InstanceId	String	amqp-cn-nif22u74****	RabbitMQ インスタンスの ID。詳細については、制限をご参照ください。
VirtualHostName	String	eb-connect	RabbitMQ インスタンスの vhost の名前。詳細については、制限をご参照ください。
QueueName	String	demo	RabbitMQ インスタンスのキューの名前。詳細については、制限をご参照ください。

レスポンスパラメータ SourceSLSParameters

パラメータ	タイプ	必須	例	説明
Project	String	はい	test-project	ログサービスプロジェクト。
LogStore	String	はい	test-logstore	ログサービスログストア。
ConsumePosition	String	いいえ	end	開始コンシューマオフセット。値 begin は最も古いオフセットを示し、値 end は最新のオフセットを示します。消費を開始する時間を秒単位で指定することもできます。
RoleName	String	はい	testRole	ロールの名前。EventBridge がこのロールを使用してログサービスのログを読み取ることを承認するには、RAM コンソールでロールを作成するときに、[選択した信頼できるエンティティ] パラメータで [Alibaba Cloud サービス] を選択し、[信頼できるサービスを選択] パラメータで [EventBridge] を選択する必要があります。

レスポンスパラメータ SinkMNSParameters

パラメータ	タイプ	例	説明
QueueName	TargetParameter		イベントターゲットが Simple Message Queue (旧称 MNS) の場合に指定するキューの名前。
Form	String	CONSTANT	変換方法。
Value	String	MyQueue	Simple Message Queue (旧称 MNS) インスタンスのキューの名前。
IsBase64Encode	TargetParameter		Base64 エンコーディングが有効かどうかを示します。
Value	String	true	Base64 エンコーディングが有効であることを示します。
Form	String	CONSTANT	変換方法。
Body	TargetParameter		メッセージの内容。
Form	String	TEMPLATE	変換方法。
Value	String	`{ "key": "value" }`	変換前の値。

レスポンスパラメータ SinkRocketMQParameters

パラメータ	タイプ	例	説明
InstanceId	TargetParameter		イベントターゲットが RocketMQ の場合に指定するインスタンスの ID。
Value	String	MQ_INST_164901546557**_BAAN**	RocketMQ インスタンスの ID。詳細については、制限をご参照ください。
Form	String	CONSTANT	変換方法。
Topic	TargetParameter		RocketMQ インスタンスのトピック。
Value	String	Mytopic	RocketMQ インスタンスのトピックの名前。詳細については、制限をご参照ください。
Form	String	CONSTANT	変換方法。
Body	TargetParameter		メッセージの内容。
Form	String	いいえ	TEMPLATE
Value	String	`{ "key": "value" }`	変換前の値。
Template	String	The value of ${key} is ${value}!	イベントの変換に使用されるテンプレート。
Properties	TargetParameter		メッセージのフィルタリングに使用されるプロパティ。
Value	String	`{ "key": "value" }`	変換前の値。
Form	String	TEMPLATE	変換方法。
Template	String	The value of ${key} is ${value}!	イベントの変換に使用されるテンプレート。
Keys	TargetParameter		メッセージのフィルタリングに使用されるプロパティ。
Value	String	`{ "key": "value" }`	変換前の値。
Form	String	TEMPLATE	変換方法。
Template	String	The value of ${key} is ${value}!	イベントの変換に使用されるテンプレート。
Tags	TargetParameter		メッセージのフィルタリングに使用されるプロパティ。
Value	String	`{ "key": "value" }`	変換前の値。
Form	String	TEMPLATE	変換方法。
Template	String	The value of ${key} is ${value}!	イベントの変換に使用されるテンプレート。

レスポンスパラメータ SinkRabbitMQParameters

パラメータ	タイプ	例	説明
InstanceId	TargetParameter		イベントターゲットが RabbitMQ の場合に指定するインスタンスの ID。
Value	String	amqp-cn-2r42e73o****	RabbitMQ インスタンスの ID。詳細については、制限をご参照ください。
Form	String	CONSTANT	変換方法。
VirtualHostName	TargetParameter		RabbitMQ インスタンスの vhost の名前。
Value	String	rabbit-host	RabbitMQ インスタンスの vhost の名前。詳細については、制限をご参照ください。
Form	String	CONSTANT	変換方法。
TargetType	TargetParameter		イベントのプッシュ先のリソースのタイプ。
Value	String	Exchange/Queue	イベントのプッシュ先のリソースのタイプ。有効な値： Exchange Queue
Form	String	CONSTANT	変換方法。
Exchange	TargetParameter		宛先インスタンスでイベントのプッシュ先の exchange の名前。このパラメータは、TargetType パラメータを Exchange に設定した場合にのみ有効です。
Value	String	a_exchange	RabbitMQ インスタンスの exchange の名前。詳細については、制限をご参照ください。
Form	String	CONSTANT	変換方法。
RoutingKey	TargetParameter		メッセージのルーティングルール。このパラメータは、TargetType パラメータを Exchange に設定した場合にのみ有効です。
Value	String	housekeeping	メッセージのルーティングルール。
Form	String	CONSTANT	変換方法。
QueueName	TargetParameter		宛先インスタンスでイベントのプッシュ先の queue の名前。このパラメータは、TargetType パラメータを Queue に設定した場合にのみ有効です。
Value	String	MyQueue	RabbitMQ インスタンスのキューの名前。詳細については、制限をご参照ください。
Form	String	CONSTANT	変換方法。
Body	TargetParameter		メッセージの内容。
Form	String	TEMPLATE	変換方法。
Value	String	`{ "key": "value" }`	変換前の値。
Template	String	The value of ${key} is ${value}!	イベントの変換に使用されるテンプレート。
MessageId	TargetParameter		メッセージの ID。
Value	String	`{ "key": "value" }`	変換前の値。
Form	String	TEMPLATE	変換方法。
Template	String	The value of ${key} is ${value}!	イベントの変換に使用されるテンプレート。
Properties	TargetParameter		メッセージのフィルタリングに使用されるプロパティ。
Value	String	`{ "key": "value" }`	変換前の値。
Form	String	TEMPLATE	変換方法。
Template	String	The value of ${key} is ${value}!	イベントの変換に使用されるテンプレート。

レスポンスパラメータ SinkSLSParameters

パラメータ	タイプ	必須	例	説明
Project	String	はい	test-project	ログサービスプロジェクト。
LogStore	String	はい	test-logstore	ログサービスログストア。
Topic	String	いいえ	testTopic	ログが存在するトピック。このパラメータの値は、ログサービスの予約フィールド「__topic__」の値と同じです。
RoleName	String	はい	testRole	ロールの名前。EventBridge がこのロールを使用してログサービスのログを読み取ることを承認するには、RAM コンソールでロールを作成するときに、[選択した信頼できるエンティティ] パラメータで [Alibaba Cloud サービス] を選択し、[信頼できるサービスを選択] パラメータで [EventBridge] を選択する必要があります。

例

リクエストの例

POST /eventstreaming/getEventStreaming 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"
}

レスポンスの例

HTTP/1.1 200 OK
Server: AliyunEventBridge
Connection: keep-alive
Content-Type: application/json;charset=utf-8
Content-Length: 79
x-eventbridge-request-id: 61027584-9E35-15F0-B9A7-9CC463D1****
Date: Sat, 18 Apr 2020 05:30:41 GMT

{
    "code":"200",
    "data":{
        "RequestId":"61027584-9E35-15F0-B9A7-9CC463D1****",
        "Data":{
            "Status":"STARTING",
            "FilterPattern":"{}",
            "Description":"rocketmq2rabbitmq",
            "Sink":{
                "SinkRabbitMQParameters":{
                    "Exchange":{
                        "Form":"CONSTANT",
                        "Value":"a_exchange"
                    },
                    "RoutingKey":{
                        "Form":"JSONPATH",
                        "Value":"housekeeping"
                    },
                    "VirtualHostName":{
                        "Form":"CONSTANT",
                        "Value":"dlq"
                    },
                    "InstanceId":{
                        "Form":"CONSTANT",
                        "Value":"amqp-cn-2r42e73o****"
                    },
                    "TargetType":{
                        "Form":"CONSTANT",
                        "Value":"Exchange"
                    },
                    "Properties":{
                        "Form":"JSONPATH",
                        "Value":"systemProperties"
                    },
                    "Body":{
                        "Form":"TEMPLATE",
                        "Value":"{"key": "value"}",
                        "Template":"The value of ${key} is ${value}."
                    },
                    "MessageId":{
                        "Form":"JSONPATH",
                        "Value":"message_001"
                    }
                }
            },
            "EventStreamingName":"myeventstreaming",
            "Source":{
                "SourceRocketMQParameters":{
                    "InstanceId":"MQ_INST_164901546557****_BAAN5UF8",
                    "RegionId":"cn-hangzhou",
                    "Tag":"",
                    "Topic":"mytopic",
                    "Offset":"CONSUME_FROM_TIMESTAMP",
                    "GroupID":"GID_group1",
                    "Timestamp":1636597951964
                }
            },
            "RunOptions":{
                "ErrorsTolerance":"ALL",
                "MaximumTasks":0,
                "RetryStrategy":{
                    "PushRetryStrategy":"BACKOFF_RETRY",
                }
            }
        },
        "Code":"Success",
        "Success":true
    },
    "httpStatusCode":"200",
    "requestId":"61027584-9E35-15F0-B9A7-9CC463D1****",
    "successResponse":true
}