PutTargets でイベントルールのイベントターゲットを作成または更新 - 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:PutTargets

update

*Rule

acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/rule/{#RuleName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EventBusName	string	必須	イベントバスの名前。	eventTest
RuleName	string	必須	イベントルールの名前。	ssr-send-to-vendor-test01
Targets	array<object>	必須	作成または更新するイベントターゲットのリスト。詳細については、「使用制限」をご参照ください。
	array<object>	任意	イベントターゲット。
Id	string	必須	イベントターゲットのカスタム ID。	Mlm123456JHd2RsRoKw
Type	string	必須	イベントターゲットのタイプ。詳細については、「イベントターゲットパラメーター」をご参照ください。	acs.fc.function
Endpoint	string	任意	イベントターゲットのエンドポイント。	acs:fc:cn-hangzhou:123456789098****:services/guide.LATEST/functions/HelloFC
PushRetryStrategy	string	任意	イベントをプッシュするためのリトライ戦略。有効値： BACKOFF_RETRY：イベントは 10 秒から 20 秒のランダムな間隔で最大 3 回リトライされます。 EXPONENTIAL_DECAY_RETRY：イベントは 24 時間にわたって最大 176 回リトライされます。リトライ間隔は 1 秒から始まり、試行ごとに倍増し (1、2、4、...、256 秒)、その後のすべてのリトライでは 512 秒に制限されます。	BACKOFFRETRY
DeadLetterQueue	object	任意	すべてのリトライ試行が失敗した後にイベントが送信されるデッドレターキュー (DLQ)。サポートされている DLQ タイプには、Message Queue for Apache RocketMQ、Message Service (MNS)、Message Queue for Apache Kafka、EventBridge があります。
Arn	string	任意	デッドレターキューの Alibaba Cloud リソース名 (ARN)。	acs:mns:cn-hangzhou:123456789098**:/queues/deadletterqueue 或 acs:mq:cn-hangzhou:123456789098:/instances/MQ_INST_123456789098_BX8QbBPL/topic/deadlettertopic 或 acs:alikafka:cn-hangzhou:123456789098:instance/alikafka_post-cn-123456/topic/deadlettertopic 或 acs:eventbridge:cn-hangzhou:123456789098**:eventbus/deadletterbus
Network	string	任意	デッドレターキューのネットワークタイプ。
VpcId	string	任意	VPC ID。
VSwitchIds	string	任意	VSwitch ID。
SecurityGroupId	string	任意	セキュリティグループ ID。
ErrorsTolerance	string	任意	フォールトトレランスポリシー。有効値： ALL：フォールトトレランスを有効にします。エラーが発生した場合、実行は継続されます。リトライ戦略で定義されたリトライ試行がすべて失敗した後、イベントは設定されたデッドレターキューに送信されるか、破棄されます。 NONE：フォールトトレランスを無効にします。すべてのリトライ試行が失敗してもエラーが続く場合、実行はブロックされます。	ALL
ParamList	array<object>	任意	イベントターゲットのパラメーターのリスト。
	object	任意	イベントターゲットパラメーター。
ResourceKey	string	任意	パラメーターのキー。詳細については、「イベントターゲットパラメーター」をご参照ください。	body
Form	string	任意	パラメーター値のフォーマット。詳細については、「イベントターゲットパラメーター」をご参照ください。	TEMPLATE
Value	string	任意	パラメーターの値。	{\"key\"=\"value\"}
Template	string	任意	パラメーター値のテンプレート。このパラメーターは、`Form` が `TEMPLATE` に設定されている場合にのみ適用されます。	The value of ${key} is ${value}!
ConcurrentConfig	object	任意	同時実行制御の設定。
Concurrency	integer	任意	イベントターゲットの最大同時実行数。	34

レスポンスフィールド

フィールド	型	説明	例
	object
Message	string	エラーメッセージ。	The event rule not existed!
RequestId	string	Alibaba Cloud がリクエストに対して生成する一意の ID。	6FB52207-7621-5292-BDF2-A17E2E984160
Data	object	返されたデータ。
ErrorEntriesCount	integer	処理に失敗したイベントターゲットの数。値が 0 の場合は、すべてのイベントターゲットが正常に処理されたことを示します。	0
ErrorEntries	array<object>	処理に失敗したイベントターゲットの詳細。
	object	失敗したイベントターゲットの詳細。
ErrorMessage	string	エラーの説明。	The id of event target is duplicate!
ErrorCode	string	エラーコード。	EventRuleTargetIdDuplicate
EntryId	string	失敗したイベントターゲットの ID。	Mlm123456JHd2RsRoKw
Code	string	応答コード。 Success：リクエストは成功しました。その他の値はエラーを示します。詳細については、「エラーコード」をご参照ください。	Success
Success	boolean	操作が成功した場合は true を返します。	true

例

成功レスポンス

JSONJSON

{
  "Message": "The event rule not existed!",
  "RequestId": "6FB52207-7621-5292-BDF2-A17E2E984160\n",
  "Data": {
    "ErrorEntriesCount": 0,
    "ErrorEntries": [
      {
        "ErrorMessage": "The id of event target is duplicate!",
        "ErrorCode": "EventRuleTargetIdDuplicate",
        "EntryId": "Mlm123456JHd2RsRoKw"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	ServiceNotEnable	Service not enable

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

変更履歴

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