CreateRule でイベントルールを作成 - 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:CreateRule

create

*Rule

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EventBusName	string	必須	イベントバスの名前。	MyEventBus
Description	string	任意	イベントルールの説明。	Filter rule for Simple Message Queue (formerly MNS) (SMQ)
RuleName	string	必須	イベントルールの名前。	SMQRule
Status	string	任意	イベントルールのステータス。有効な値：`ENABLE`：ルールは有効です。これがデフォルト値です。`DISABLE`：ルールは無効です。	ENABLE
FilterPattern	string	必須	JSON 形式のイベントパターン。サポートされているパターンタイプは `stringEqual` と `stringExpression` です。各フィールドには、マップ構造で最大 5 つの式を含めることができます。	{ "source": [ { "prefix": "acs." } ], "type": [ { "prefix": "oss:ObjectReplication" } ], "subject": [ { "prefix": "acs:oss:cn-hangzhou:123456789098****:my-movie-bucket/", "suffix": ".txt" } ] }
EventTargets	array<object>	任意	イベントターゲットのリスト。
	array<object>	任意	イベントターゲット。
Id	string	必須	イベントターゲットのカスタム ID。	Mlm123456JHd2RsRoKw
Type	string	必須	イベントターゲットのタイプ。詳細については、「イベントターゲットのパラメーター」をご参照ください。	acs.mns.queue
Endpoint	string	任意	イベントの配信エンドポイント。	acs:mns:cn-hangzhou:123456789098****:queues/myqueue
PushRetryStrategy	string	任意	プッシュリトライ戦略。有効な値： `BACKOFF_RETRY`：バックオフ再試行戦略。システムは 10 秒から 20 秒のランダムな間隔で 3 回再試行します。 `EXPONENTIAL_DECAY_RETRY`：指数減衰再試行戦略。システムは 24 時間にわたって 176 回再試行します。間隔は 1 秒から始まり、最初の 10 回の試行ごとに倍増します (最大 512 秒)。その後の再試行は 512 秒ごとに行われます。	BACKOFF_RETRY
DeadLetterQueue	object	任意	デッドレターキュー。イベントの処理に失敗した場合、またはリトライの上限を超えた場合、イベントはデッドレターキューに送信されます。デッドレターキューでサポートされているサービスには、Message Queue for Apache RocketMQ、Message Service (MNS)、Message Queue for Apache Kafka、EventBridge イベントバスが含まれます。
Arn	string	任意	デッドレターキューの Alibaba Cloud リソース名 (ARN)。処理に失敗した、またはリトライの上限を超えたイベントがこの ARN に送信されます。このパラメーターでサポートされているサービスには、Message Service (MNS) と Message Queue for Apache RocketMQ が含まれます。	acs:mns:cn-hangzhou:123456789098****:/queues/deadletterqueue
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	任意	イベントターゲットパラメーターのテンプレート。	The value of ${key} is ${value}!
ConcurrentConfig	object	任意	同時実行制御設定。
Concurrency	integer	任意	イベントターゲットの最大同時実行数。	2

リクエストの例

POST /openapi/createRule HTTP/1.1 Host: 123456789098****.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

{ "EventBusName":"default", "RuleName":"MNSRule", "Description":"Filter rule for MNS", "Status":"ENABLE", "filterPattern":"{\"source\": [{\"prefix\": \"acs.\"}],\"type\": [{\"prefix\":\"oss:ObjectReplication\"}],\"subject\":[{\"prefix\":\"acs:oss:cn-hangzhou:123456789098****:my-movie-bucket/\", \"suffix\":\".txt\"}]}", "EventTargets":[ { "Id":"1", "Type":"acs.mns.queue", "Endpoint":"acs:mns:cn-hangzhou:123456789098****:queues/myqueue", "PushRetryStrategy":"BACKOFF_RETRY", "DeadLetterQueue":{ "Arn":"acs:mns:cn-hangzhou:123456789098****:/queues/rule-deadletterqueue" }, "ParamList":[ { "resourceKey":"queue", "form":"CONSTANT", "value":"myqueue" }, { "resourceKey":"body", "form":"TEMPLATE", "value":"{\"key\"=\"value\"}", "template":"The value of ${key} is ${value}!" } ] } ] }

レスポンスフィールド

フィールド	型	説明	例
	object
Message	string	エラーメッセージ。	Remote error. requestId: [xxxx], error code: [xxx], message: [The target in event rule is invalid! Endpoint is xxx
RequestId	string	リクエスト ID。	1AD6D598-7506-5D2C-81EA-30E3241A903A
Data	object	応答データ。
RuleARN	string	権限付与に使用されるイベントルールの ARN。	acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/MNSRule
Code	string	応答コード。値 Success は、リクエストが成功したことを示します。その他の値は、リクエストが失敗したことを示します。エラーコードの詳細については、「エラーコード」をご参照ください。	Success
Success	boolean	操作が成功したかどうかを示します。値 true は、操作が成功したことを示します。	true

例

成功レスポンス

JSONJSON

{
  "Message": "Remote error. requestId: [xxxx], error code: [xxx], message: [The target in event rule is invalid! Endpoint is xxx",
  "RequestId": "1AD6D598-7506-5D2C-81EA-30E3241A903A",
  "Data": {
    "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/MNSRule"
  },
  "Code": "Success",
  "Success": true
}

エラーコード

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

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

変更履歴

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