GetEventRule - Simple Message Queue (formerly MNS) - Alibaba Cloud Documentation Center

Retrieves an event notification rule.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mns:GetEventRule

get

*Topic

acs:mns:{#regionId}:{#accountId}:/products/{#ProductName}/rules

None

Request parameters

Parameter	Type	Required	Description	Example
ProductName	string	Yes	The name of the Alibaba Cloud product that triggers the event notification.	oss
RuleName	string	Yes	The name of the event notification rule.	rule-xsXDW

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	06273500-249F-5863-121D-74D51123****
Code	integer	The response code.	200
Status	string	The status of the response.	Success
Message	string	The response message.	operation success
Success	boolean	Indicates whether the request was successful.	True
Data	object	The query results.
RuleName	string	The name of the event notification rule.	event-recorder
EventTypes	array	A list of event types.
	string	The full name of the event type.	["oss:ObjectModified:UpdateObjectMeta"]
MatchRules	array	The event matching rules. The rules have an OR relationship.
	array	The event matching rules. The rules have an OR relationship.
	EventMatchRule	The event matching rules. The rules have an OR relationship.
Subscriptions	array<object>	Subscription endpoints.
	object
EndpointType	string	The endpoint type. Valid values: queue: A queue. topic: A topic.	queue
EndpointValue	string	The value of the endpoint.	retry-queue
TopicName	string	The name of the topic.	demo-topic
Endpoint	object	The endpoint address.
EndpointType	string	The endpoint type. Valid values: queue: A queue. topic: A topic.	queue
EndpointValue	string	The value of the endpoint.	retry-queue
DeliveryMode	string	This field is deprecated.	--

Examples

Success response

JSON format

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "RuleName": "event-recorder",
    "EventTypes": [
      "[\"oss:ObjectModified:UpdateObjectMeta\"]"
    ],
    "MatchRules": [
      [
        {
          "MatchState": true,
          "Name": "testBucket/folder1/file1",
          "Prefix": "testBucket/prefix1xxx",
          "Suffix": "suffix/xxxx.test"
        }
      ]
    ],
    "Subscriptions": [
      {
        "EndpointType": "queue",
        "EndpointValue": "retry-queue"
      }
    ],
    "TopicName": "demo-topic",
    "Endpoint": {
      "EndpointType": "queue",
      "EndpointValue": "retry-queue"
    },
    "DeliveryMode": "--"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.