GetRule を使用してイベントルール詳細を取得 - 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:GetRule

get

*Rule

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EventBusName	string	必須	イベントバスの名前。	default
RuleName	string	必須	ルールの名前。	ram-changes

レスポンスフィールド

フィールド	型	説明	例
	object
Message	string	エラーメッセージ。	The event rule not existed!
RequestId	string	Alibaba Cloud によって生成された一意のリクエスト ID。	2BC1857D-E633-5E79-B2C2-43EF5F7730D8
Data	object	応答データ。
Status	string	ルールのステータス。有効な値： ENABLE：ルールは有効です。これがデフォルト値です。 DISABLE：ルールは無効です。	ENABLE
EventBusName	string	イベントバスの名前。	Housekeeping-Bus
RuleARN	string	ルールの ARN。	acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3
Description	string	ルールの説明。	test
Targets	array<object>	イベントターゲットのリスト。
	array<object>	イベントターゲット。
DetailMap	object	イベントターゲットの詳細。
Type	string	イベントターゲットのタイプ。詳細については、「イベントターゲットパラメーター」をご参照ください。	acs.mns.queue
Endpoint	string	イベントの配信エンドポイント。	acs:mns:cn-hangzhou:123456789098****:queues/myqueue
ParamList	array<object>	イベントターゲットのパラメーターのリスト。
	object	イベントターゲットのパラメーター。
Value	string	イベントターゲットパラメーターの値。	{\"key\"=\"value\"}
Template	string	イベントターゲットパラメーターのテンプレート。	The value of ${key} is ${value}!
Form	string	イベントターゲットパラメーターのフォーマット。詳細については、「使用制限」をご参照ください。	TEMPLATE
ResourceKey	string	イベントターゲットのリソースキー。詳細については、「使用制限」をご参照ください。	body
PushSelector	string	プッシュセレクター。	PARAM_TRANSFORMER
Id	string	イベントターゲットのカスタム ID。	Mlm123456JHd2RsRoKw
DeadLetterQueue	object	デッドレターキュー。
Arn	string	デッドレターキューの Alibaba Cloud リソースネーム (ARN)。	acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
Network	string	デッドレターキューのネットワークタイプ。
VpcId	string	VPC ID。
VSwitchIds	string	vSwitch ID。
SecurityGroupId	string	セキュリティグループ ID。
PushRetryStrategy	string	イベントをプッシュするためのリトライポリシー。有効な値： BACKOFF_RETRY：バックオフ再試行ポリシー。イベントは 10 秒から 20 秒のランダムな間隔で 3 回再試行されます。 EXPONENTIAL_DECAY_RETRY：指数減衰再試行ポリシー。イベントは 1 日に 176 回再試行されます。再試行間隔は 1 秒から始まり、最大 512 秒まで指数関数的に増加します。具体的な再試行間隔は、1、2、4、8、16、32、64、128、256 秒で、残りの 167 回は 512 秒です。	BACKOFF_RETRY
ConcurrentConfig	object	同時実行数の設定。
Concurrency	integer	最大同時プッシュ数。	2
ErrorsTolerance	string	フォールトトレランスポリシー。有効な値： ALL：フォールトトレランスを有効にします。エラーはイベント配信をブロックしません。すべての再試行が失敗した場合、システムはイベントを指定されたデッドレターキューに送信するか、破棄します。 NONE：フォールトトレランスを無効にします。すべての再試行後もエラーが続く場合、システムはイベント配信をブロックします。	ALL
FilterPattern	string	JSON フォーマットのイベントパターン。次のモードがサポートされています： stringEqual モード：マップ構造では、各フィールドに最大 5 つの式を含めることができます。 stringExpression モード：マップ構造では、各フィールドに最大 5 つの式を含めることができます。	{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}
CreatedTimestamp	integer	ルールの作成タイムスタンプ。	1607071602000
RuleName	string	ルールの名前。	ramrolechange-fc
Code	string	応答コード。有効な値： Success：リクエストは成功しました。その他の値：リクエストはエラーコードを返しました。詳細については、「エラーコード」をご参照ください。	Success
Success	boolean	操作が成功したかどうかを示します。`true` の値は成功を示します。	true

例

成功レスポンス

JSONJSON

{
  "Message": "The event rule not existed!",
  "RequestId": "2BC1857D-E633-5E79-B2C2-43EF5F7730D8",
  "Data": {
    "Status": "ENABLE",
    "EventBusName": "Housekeeping-Bus",
    "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3",
    "Description": "test",
    "Targets": [
      {
        "DetailMap": {
          "test": "test",
          "test2": 1
        },
        "Type": "acs.mns.queue",
        "Endpoint": "acs:mns:cn-hangzhou:123456789098****:queues/myqueue",
        "ParamList": [
          {
            "Value": "{\\\"key\\\"=\\\"value\\\"}",
            "Template": "The value of ${key} is ${value}!",
            "Form": "TEMPLATE",
            "ResourceKey": "body"
          }
        ],
        "PushSelector": "PARAM_TRANSFORMER",
        "Id": "Mlm123456JHd2RsRoKw\n",
        "DeadLetterQueue": {
          "Arn": "acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source",
          "Network": "",
          "VpcId": "",
          "VSwitchIds": "",
          "SecurityGroupId": ""
        },
        "PushRetryStrategy": "BACKOFF_RETRY",
        "ConcurrentConfig": {
          "Concurrency": 2
        },
        "ErrorsTolerance": "ALL"
      }
    ],
    "FilterPattern": "{\\\"source\\\":[\\\"acs.oss\\\"],\\\"type\\\":[\\\"oss:BucketQueried:GetBucketStat\\\"]}",
    "CreatedTimestamp": 1607071602000,
    "RuleName": "ramrolechange-fc"
  },
  "Code": "Success",
  "Success": true
}

エラーコード

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

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

変更履歴

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