GetRule - EventBridge - Alibaba Cloud Documentation Center

Queries the details of an event rule.

Operation description

You can call this API operation to query the details of an event rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eventbridge:GetRule	Read	Rule acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#eventbusId}/rule/{#ruleId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
EventBusName	string	Yes	The name of the event bus.	default
RuleName	string	Yes	The name of the event rule.	ram-changes

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The returned error message.	The event rule not existed!
RequestId	string	The request ID.	2BC1857D-E633-5E79-B2C2-43EF5F7730D8
Data	object	The returned data.
Status	string	The status of the event rule. Valid values: ENABLE (default): The event rule is enabled. DISABLE: The event rule is disabled.	ENABLE
EventBusName	string	The name of the event bus.	Housekeeping-Bus
RuleARN	string	The Alibaba Cloud Resource Name (ARN) of the event rule.	acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3
Description	string	The description of the event rule.	test
Targets	object []	The event targets.
DetailMap	object	The information about the event target.
Type	string	The type of the event target. For more information, see Event target parameters.	acs.mns.queue
Endpoint	string	The endpoint of the event target.	acs:mns:cn-hangzhou:123456789098****:queues/myqueue
ParamList	object []	The parameters that are configured for the event target.
Value	string	The event target.	{\"key\"=\"value\"}
Template	string	The template based on which events are delivered to the event target.	The value of ${key} is ${value}!
Form	string	The method that is used to deliver events to the event target. For more information, see Limits .	TEMPLATE
ResourceKey	string	The resource key of the event target. For more information, see Limits .	body
PushSelector	string	The transformer that is used to push events.	MATCHED_EVENT
Id	string	The ID of the event target.	1
DeadLetterQueue	object	The dead-letter queue.
Arn	string	The Alibaba Cloud Resource Name (ARN) of the dead-letter queue.	acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
PushRetryStrategy	string	The retry policy that is used to push failed events. Valid values: BACKOFF_RETRY: backoff retry. A failed event can be retried up to three times. The interval between two consecutive retries is a random value between 10 seconds and 20 seconds. EXPONENTIAL_DECAY_RETRY: exponential decay retry. A failed event can be retried up to 176 times. The interval between two consecutive retries exponentially increases to a maximum of 512 seconds. The total retry time is 1 day. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, and 512 seconds. The interval of 512 seconds is used for 167 retries.	BACKOFF_RETRY
ErrorsTolerance	string	The fault tolerance policy. Valid values: ALL: Fault tolerance is allowed. If an error occurs in an event, event processing is not blocked. If the event fails to be sent after the maximum number of retries specified by the retry policy is reached, the event is delivered to the dead-letter queue or discarded based on your configurations. NONE: Fault tolerance is not allowed. If an error occurs in an event and the event fails to be sent after the maximum number of retries specified by the retry policy is reached, event processing is blocked.	ALL
FilterPattern	string	The event pattern, in JSON format. Valid values: stringEqual and stringExpression. You can specify up to five expressions in the map data structure in each field. You can specify up to five expressions in the map data structure in each field.	{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}
CreatedTimestamp	long	The timestamp that indicates when the event rule was created.	1607071602000
RuleName	string	The name of the event rule.	ramrolechange-fc
Code	string	The response code. The value Success indicates that the request is successful. Other values indicate that the request failed. For a list of error codes, see Error codes.	Success
Success	boolean	Indicates whether the operation is successful. If the operation is successful, the value true is returned.	true

Examples

Sample success responses

JSONformat

{
  "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": "MATCHED_EVENT",
        "Id": "1",
        "DeadLetterQueue": {
          "Arn": "acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source"
        },
        "PushRetryStrategy": "BACKOFF_RETRY",
        "ErrorsTolerance": "ALL"
      }
    ],
    "FilterPattern": "{\\\"source\\\":[\\\"acs.oss\\\"],\\\"type\\\":[\\\"oss:BucketQueried:GetBucketStat\\\"]}",
    "CreatedTimestamp": 1607071602000,
    "RuleName": "ramrolechange-fc"
  },
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
403	ServiceNotEnable	Service not enable

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-07-04

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 403
Output Parameters	The response structure of the API has changed.