すべてのプロダクト
Search

このプロダクト

    EventBridge:ListRules

    ドキュメントセンター

    EventBridge:ListRules

    最終更新日:Dec 23, 2025

    イベントバスのすべてのルールをクエリします。

    操作説明

    この API 操作を呼び出して、イベントバスのすべてのルールをクエリできます。

    今すぐお試しください

    この 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:ListRules

    get

    *Rule

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RuleNamePrefix

    string

    任意

    ルール名のプレフィックス。

    test
    Limit

    integer

    任意

    1回の呼び出しで返されるエントリの最大数。このパラメーターと NextToken パラメーターを使用して、ページングを実装できます。1回の呼び出しで最大 100 件のエントリを返すことができます。

    50
    NextToken

    string

    任意

    Limit パラメーターを設定し、返す結果がまだある場合に、このパラメーターが返されます。

    1000
    EventBusName

    string

    必須

    イベントバスの名前。

    default

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Message

    string

    リクエストが失敗した場合に返されるエラーメッセージ。

    Specified parameter Limit is not valid.
    RequestId

    string

    リクエスト ID。

    C7043799-F4DA-5290-9249-97C359876D97
    Data

    object

    返されたデータ。

    NextToken

    string

    返す結果がまだある場合に、このパラメーターが返されます。

    1000
    Total

    integer

    エントリの総数。

    6
    Rules

    array<object>

    イベントルール。

    array<object>

    イベントルール。

    DetailMap

    object

    イベントルールの詳細。

    Status

    string

    イベントルールのステータス。有効な値：

    • ENABLE (デフォルト)

    • DISABLE

    ENABLE
    EventBusName

    string

    イベントバスの名前。

    demo
    RuleARN

    string

    ルールの Alibaba Cloud リソース名 (ARN)。

    acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3
    Description

    string

    ルールの説明。

    demo
    Targets

    array<object>

    イベントターゲット。

    object

    イベントターゲット。

    Type

    string

    イベントターゲットのタイプ。詳細については、「イベントターゲットのパラメーター」をご参照ください。

    acs.mns.queue

    Endpoint

    string

    イベントターゲットのエンドポイント。

    acs:mns:cn-hangzhou:123456789098****:queues/myqueue
    Id

    string

    カスタムイベントターゲットの ID。

    177
    PushSelector

    string

    イベントのプッシュに使用されるトランスフォーマー。

    MATCHED_EVENT
    ErrorsTolerance

    string

    フォールトトレランスポリシー。有効な値：

    • ALL：フォールトトレランスが許可されます。イベントでエラーが発生しても、イベント処理はブロックされません。リトライポリシーで指定された最大リトライ回数に達してもイベントの送信に失敗した場合、イベントは構成に基づいてデッドレターキューに配信されるか、破棄されます。

    • NONE：フォールトトレランスは禁止されています。イベントでエラーが発生し、リトライポリシーで指定された最大リトライ回数に達してもイベントの送信に失敗した場合、イベント処理はブロックされます。

    ALL
    FilterPattern

    string

    イベントパターン (JSON 形式)。有効な値：

    • stringEqual：各フィールドで、マップデータ構造の式を最大 5 つ指定できます。

    • stringExpression：各フィールドで、マップデータ構造の式を最大 5 つ指定できます。

    {\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}

    CreatedTimestamp

    integer

    作成タイムスタンプ。

    1607071602000
    RuleName

    string

    イベントルールの名前。

    tf-testacc-rule
    Code

    string

    応答コード。

    • Success：リクエストは成功しました。

    • その他のコード：リクエストは失敗しました。エラーコードの詳細については、「エラーコード」をご参照ください。

    Success
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：true と false。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Message": "Specified parameter Limit is not valid.",
  "RequestId": "C7043799-F4DA-5290-9249-97C359876D97",
  "Data": {
    "NextToken": "1000",
    "Total": 6,
    "Rules": [
      {
        "DetailMap": {
          "test": "test",
          "test2": 1
        },
        "Status": "ENABLE",
        "EventBusName": "demo",
        "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3",
        "Description": "demo",
        "Targets": [
          {
            "Type": "acs.mns.queue\n",
            "Endpoint": "acs:mns:cn-hangzhou:123456789098****:queues/myqueue",
            "Id": "177",
            "PushSelector": "MATCHED_EVENT",
            "ErrorsTolerance": "ALL"
          }
        ],
        "FilterPattern": "{\\\"source\\\":[\\\"acs.oss\\\"],\\\"type\\\":[\\\"oss:BucketQueried:GetBucketStat\\\"]}\n",
        "CreatedTimestamp": 1607071602000,
        "RuleName": "tf-testacc-rule"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 ServiceNotEnable Service not enable

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

    変更履歴

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