全部產品
Search

搜尋本產品

    EventBridge：GetRule - 擷取一個事件規則的詳細資料

    文件中心

    EventBridge：GetRule - 擷取一個事件規則的詳細資料

    更新時間：Apr 24, 2026

    擷取一個事件規則的詳細資料。

    介面說明

    擷取一個事件規則的詳細資料。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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

    阿里雲為該請求產生的唯一識別碼。

    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

    查詢到的無效信件佇列在阿里雲上的統一資源標識（ARN）。

    acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
    Network

    string

    無效信件佇列的網路類型。

    VpcId

    string

    VPC ID。

    VSwitchIds

    string

    虛擬交換器 ID。

    SecurityGroupId

    string

    安全性群組 ID。

    PushRetryStrategy

    string

    推送重試策略。取值說明如下：

    • BACKOFF_RETRY：退避重試策略。重試 3 次，每次重試的間隔時間是 10 秒到 20 秒之間的隨機值。

    • EXPONENTIAL_DECAY_RETRY：指數衰減重試。重試 176 次，每次重試的間隔時間指數遞增至 512 秒，總計重試時間為 1 天；每次重試的具體間隔為：1，2，4，8，16，32，64，128，256，512，512...512 秒（共 167 個 512）。

    BACKOFF_RETRY
    ConcurrentConfig

    object

    並發配置。

    Concurrency

    integer

    並發數。

    2
    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

    規則名稱。

    ramrolechange-fc
    Code

    string

    介面返回碼。取值說明如下：

    • Success：表示成功。

    • 其它：表示錯誤碼。錯誤碼詳情，請參見錯誤碼。

    Success
    Success

    boolean

    操作成功返回 true。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "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 status code

    錯誤碼

    錯誤資訊

    描述
    403 ServiceNotEnable Service not enable

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

    變更歷史

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