調用ListRules查詢事件匯流排的所有事件規則-事件匯流排-阿里雲

查詢一個事件匯流排的所有規則。

介面說明

查詢一個事件匯流排的所有規則。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

eventbridge:ListRules

get

*Rule

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

無

請求參數

名稱	類型	必填	描述	樣本值
RuleNamePrefix	string	否	規則名稱首碼。	test
Limit	integer	否	限定每次返回的最大條數，可以和 NextToken 搭配使用實現翻頁能力。重要每次返回的最大條數不超過 100。	50
NextToken	string	否	當指定 Limit 時，如果還有多餘的傳回值則會返回 NextToken。	1000
EventBusName	string	是	事件匯流排的名稱。	default

返回參數

名稱	類型	描述	樣本值
	object
Message	string	錯誤資訊。	Specified parameter Limit is not valid.
RequestId	string	阿里雲為該請求產生的唯一識別碼。	C7043799-F4DA-5290-9249-97C35987****
Data	object	返回資料。
NextToken	string	如果還有多餘的傳回值則會返回 NextToken。	1000
Total	integer	總條數。	6
Rules	array<object>	規則列表。
	array<object>	規則列表。
DetailMap	object	詳細資料。
Status	string	規則的狀態。取值說明如下： ENABLE：規則已啟用。規則預設狀態。 DISABLE：規則已禁用。	ENABLE
EventBusName	string	事件匯流排的名稱。	demo
RuleARN	string	規則 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。	Mlm123456JHd2Rs****
PushSelector	string	發布選取器。	PARAM_TRANSFORMER
ErrorsTolerance	string	容錯策略。取值說明如下： ALL：允許容錯。允許異常容錯，當異常發生時不會阻塞執行，超過重試策略後會根據配置將訊息投遞至無效信件佇列或直接丟棄。 NONE：禁止容錯。不允許容錯，當異常發生並超過重試策略配置時會阻塞執行。	ALL
FilterPattern	string	事件模式，JSON 格式。取值說明如下： stringEqual 模式：每個 field 最多 5 個 expression（map 結構）。 stringExpression 模式：每個 field 最多 5 個 expression（map 結構）。	{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}
CreatedTimestamp	integer	建立時間戳記。	1607071602000
RuleName	string	事件規則的名稱。	tf-testacc-rule
Code	string	介面返回碼。 Success：表示成功。其它：表示錯誤碼。錯誤碼詳情，請參見錯誤碼。	Success
Success	boolean	操作成功返回 true。	true

樣本

正常返回樣本

JSON格式

{
  "Message": "Specified parameter Limit is not valid.",
  "RequestId": "C7043799-F4DA-5290-9249-97C35987****",
  "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": "Mlm123456JHd2Rs****",
            "PushSelector": "PARAM_TRANSFORMER",
            "ErrorsTolerance": "ALL"
          }
        ],
        "FilterPattern": "{\\\"source\\\":[\\\"acs.oss\\\"],\\\"type\\\":[\\\"oss:BucketQueried:GetBucketStat\\\"]}\n",
        "CreatedTimestamp": 1607071602000,
        "RuleName": "tf-testacc-rule"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	ServiceNotEnable	Service not enable

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。