SMN-Enabled Event Notifications¶
Simple Message Notification (SMN) is a reliable and extensible message notification service that can handle a huge number of messages. It significantly simplifies system coupling and can automatically push messages to endpoints via email or text message.
OBS leverages SMN to provide event notifications. In OBS, you can use SMN to send event notifications to specified subscribers, so that you will be informed of any critical operations (such as upload and deletion) that occur on specified buckets in real time. For example, you can configure an event notification rule to send messages through SMN to the specified email address whenever an upload operation occurs on the specified bucket.
You can configure the event notification rule to filter objects by the object name prefix or suffix. For example, you can add an event notification rule to send notifications whenever an object with the .jpg suffix is uploaded to the specified bucket. You can also add an event notification rule to send notifications whenever an object with the images/ prefix is uploaded to the specified bucket.
For details about events supported by SMN and how to configure an SMN-enabled event notification rule, see Configuring SMN-Enabled Event Notification.
Figure 1 SMN-enabled event notification¶
The message structure of an SMN notification is as follows:
{
"Records":[
{
"eventVersion":"", //Version number. The current version is 3.0.
"eventSource":"", //Message source. The value is fixed to OBS.
"eventRegion":"", //Region where the event occurs
"eventTime":"", //Time when an event occurs, in the ISO-8601 format, for example, 2020-07-10T09:24:11.418Z
"eventName":"", //Name of the event that triggers the notification
"userIdentity":{
"ID":"" //Billing ID of the user who triggers the event
},
"requestParameters":{
"sourceIPAddress":"" //Source IP address of the request
},
"responseElements":{
"x-obs-request-id":"", //ID of the request
"x-obs-id-2":"" ///Special characters for locating problems
},
"obs":{
"Version":"1.0",
"configurationId":"", //Name of the event notification rule in OBS that matches the event
"bucket":{
"name":"examplebucket",
"ownerIdentity":{
"ID":"" //Account ID of the bucket owner
},
"bucket":"" //Bucket name
},
"object":{
"key":"", //Object name
"eTag":"", //ETag of the object
"size": , //Object size
"versionId":"null", //Version ID of the object
"sequencer":"" //Identifier that defines the event sequence of a specific object
}
}
}
]
}