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

イベントソースの構成を更新します。

URL

/openapi/updateEventSource

使用上の注意

イベントソースに対して SourceMNSParameters、SourceRocketMQParameters、SourceRabbitMQParameters、SourceHttpEventParameters、SourceSLSParameters パラメーターのいずれか 1 つのみを指定できます。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
EventSourceName	String	はい	myrabbitmq.source	イベントソースの名前。詳細については、「制限」をご参照ください。
Description	String	はい	Event source of the Message Queue for RabbitMQ type	イベントソースの説明。
SourceMNSParameters	Object	いいえ		イベントプロバイダーが Simple Message Queue（旧称 MNS）であることを指定します。詳細については、「リクエストパラメーター SourceMNSParameters」をご参照ください。
SourceRocketMQParameters	Object	いいえ		イベントプロバイダーが RocketMQ for ApsaraMQ であることを指定します。詳細については、「リクエストパラメーター SourceRocketMQParameters」をご参照ください。
SourceRabbitMQParameters	Object	いいえ		イベントプロバイダーが RabbitMQ for ApsaraMQ であることを指定します。詳細については、「リクエストパラメーター SourceRabbitMQParameters」をご参照ください。
SourceHttpEventParameters	Object	いいえ		イベントプロバイダーが HTTP または HTTPS であることを指定します。詳細については、「リクエストパラメーター SourceHttpEventParameters」をご参照ください。
SourceSLSParameters	Object	いいえ		イベントプロバイダーがログサービスであることを指定します。詳細については、「リクエストパラメーター SourceSLSParameters」をご参照ください。
EventBusName	String	はい	my-event-bus	イベントソースを関連付けるイベントバスの名前。詳細については、「制限」をご参照ください。

リクエストパラメーター SourceMNSParameters

SourceMNSParameters パラメーターを指定する場合、以下の表に示すパラメーターを構成できます。

パラメーター	タイプ	必須	例	説明
RegionId	String	はい	cn-zhangjiakou	Simple Message Queue（旧称 MNS）キューが存在するリージョンの ID。
QueueName	String	はい	MyQueue	Simple Message Queue（旧称 MNS）インスタンスのキューの名前。
IsBase64Decode	String	はい	true	Base64 デコードを有効にするかどうかを指定します。デフォルト値：true。

リクエストパラメーター SourceRocketMQParameters

SourceRocketMQParameters パラメーターを指定する場合、以下の表に示すパラメーターを構成できます。

パラメーター	タイプ	必須	例	説明
RegionId	String	はい	cn-zhangjiakou	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：最新のオフセットから消費を開始します。 CONSUME_FROM_FIRST_OFFSET：最も古いオフセットから消費を開始します。 CONSUME_FROM_TIMESTAMP：指定した時点のオフセットから消費を開始します。デフォルト値：CONSUME_FROM_LAST_OFFSET。
Timestamp	Long	いいえ	1636597951964	消費を開始するオフセットのタイムスタンプ。単位：ミリ秒。このパラメーターは、Offset パラメーターを CONSUME_FROM_TIMESTAMP に設定した場合にのみ有効です。
GroupID	String	はい	GID_group1	RocketMQ for ApsaraMQ インスタンスのグループの ID。

リクエストパラメーター SourceRabbitMQParameters

SourceRabbitMQParameters パラメーターを指定する場合、以下の表に示すパラメーターを構成できます。

パラメーター	タイプ	必須	例	説明
RegionId	String	はい	cn-zhangjiakou	RabbitMQ for ApsaraMQ インスタンスが存在するリージョンの ID。
InstanceId	String	はい	amqp-cn-nif22u74****	RabbitMQ for ApsaraMQ インスタンスの ID。詳細については、「制限」をご参照ください。
VirtualHostName	String	はい	eb-connect	RabbitMQ for ApsaraMQ インスタンスの vhost の名前。詳細については、「制限」をご参照ください。
QueueName	String	はい	demo	RabbitMQ for ApsaraMQ インスタンスのキューの名前。詳細については、「制限」をご参照ください。

リクエストパラメーター SourceHttpEventParameters

SourceHttpEventParameters パラメーターを指定する場合、以下の表に示すパラメーターを設定できます。

パラメーター	タイプ	必須	例	説明
Type	String	はい	HTTPS	生成された webhook URL でサポートされるプロトコルタイプ。有効な値： HTTP HTTPS HTTP&HTTPS
Method	List	はい	GET	生成された webhook URL でサポートされる HTTP リクエストメソッド。複数の値を選択できます。有効な値： GET POST PUT PATCH DELETE HEAD OPTIONS TRACE CONNECT
SecurityConfig	String	はい	ip	セキュリティ設定のタイプ。有効な値： none：セキュリティ設定なし。 ip：CIDR ブロック。 referer：セキュリティドメイン名。
Ip	List	いいえ	10.0.0.0/8	セキュリティ設定に使用される CIDR ブロック。SecurityConfig パラメーターを ip に設定した場合にのみ必須です。CIDR ブロックまたは IP アドレスを入力できます。複数の CIDR ブロックまたは IP アドレスはコンマ（,）で区切ります。
Referer	List	いいえ	aliyundoc.com	セキュリティドメイン名。このパラメーターは、SecurityConfig パラメーターを referer に設定した場合にのみ必須です。ドメイン名を入力できます。

リクエストパラメーター SourceSLSParameters

SourceSLSParameters パラメーターを指定する場合、以下の表に示すパラメーターを設定できます。

パラメーター	タイプ	必須	例	説明
RoleName	String	はい	testRole	EventBridge がこのロールを使用してログサービスのログを読み取ることを承認する場合、RAM（Resource Access Management）コンソールでロールを作成する際に、[選択された信頼エンティティ] パラメーターで [Alibaba Cloud サービス] を選択し、[信頼できるサービスを選択] パラメーターで [EventBridge] を選択する必要があります。

レスポンスパラメーター

イベントソースの構成が更新されると、HTTP ステータスコード 200 が返され、レスポンスボディは返されません。

例：RocketMQ for ApsaraMQ タイプのイベントソースの構成を変更する

リクエストの例

POST /openapi/updateEventSource 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

{
    "EventSourceName":"myRocketMQ.source",
    "Description":"Event source of the Message Queue for Apache RocketMQ type",
    "SourceRocketMQParameters":{
        "InstanceId":"MQ_INST_164901546557****_BAAN****",
        "GroupID":"GID_group1",
        "Topic":"mytopic",
        "Offset":"CONSUME_FROM_LAST_OFFSET",
        "Tag":"test",
        "RegionId":"cn-hangzhou"
    },
    "EventBusName":"my-event-bus"
}

レスポンスの例

HTTP/1.1 200 OK
Server: AliyunEventBridge
Connection: keep-alive
Content-Type: application/json;charset=utf-8
Content-Length: 79
x-eventbridge-request-id: 45d93c3b-7763-451b-b240-a5f1c2cc****
Date: Sat, 18 Apr 2020 05:30:41 GMT
{
    "code":"200",
    "data":{
        "RequestId":"45d93c3b-7763-451b-b240-a5f1c2cc****",
        "Data":true,
        "Code":"Success",
        "Success":true
    },
    "httpStatusCode":"200",
    "requestId":"45d93c3b-7763-451b-b240-a5f1c2cc****",
    "successResponse":true
}