Simple Message Queue (formerly MNS):OSS event notifications

Use cases

• Monitor resource activity. Create rules to receive notifications when other users perform operations on your buckets.

• Analyze data and trends. Track operational frequency over time, or import notification messages into services such as E-MapReduce (EMR) for further analysis.

• Monitor operational metrics. Track metrics such as queries per second (QPS) for specific operations on your resources.

Event types

Message format

OSS event notification messages are Base64-encoded JSON objects. The following example shows a decoded message payload.

{
    "events":[
        {
            "eventName":"ObjectDownloaded:GetObject",
            "eventSource":"acs:oss",
            "eventTime":"2016-07-01T11:17:30.000Z",
            "eventVersion":"1.0",
            "oss":{
                "bucket":{
                    "arn":"acs:oss:cn-shenzhen:123456789098****:event-notification-test-shenzhen",
                    "name":"event-notification-test-shenzhen",
                    "ownerIdentity":"123456789098****"
                },
                "object":{
                    "deltaSize":0,
                    "eTag":"0CC175B9C0F1B6A831C399E26977****",
                    "key":"test",
                    "readFrom":0,
                    "readTo":1,
                    "size":1
                },
                "ossSchemaVersion":"1.0",
                "ruleId":"GetObjectRule"
            },
            "region":"cn-shenzhen",
            "requestParameters":{
                "sourceIPAddress":"140.205.XX.XX"
            },
            "responseElements":{
                "requestId":"5776514AF09A9E654242****"
            },
            "userIdentity":{
                "principalId":"123456789098****"
            },
            "xVars":{
                "x:callback-var1":"value1",
                "x:callback-var2":"value2"
            }
        }
    ]
}

The message payload contains the following parameters.

Usage notes

• Event notification rules take about 10 minutes to take effect after creation.

• A topic is created for each new rule and may incur charges per the Billing guide.

• Event notification rules can be created and deleted but not modified.

(Optional) Step 1: Create a queue

Create a queue if you plan to use one as the notification destination. You can also add subscriptions after creating the event rule.

1. Log on to the SMQ console.

2. In the left-side navigation pane, choose Queue Model > Queues.

3. In the top navigation bar, select a region.

4. On the Queues page, click Create Queue.

5. In the Create Queue panel, configure the following parameters and click OK:

   • Name: the name of the queue.

   • Maximum Message Length: the maximum length of the message that is sent to the queue.

   • Long Polling Period: the maximum duration for which long polling requests are held after the ReceiveMessage operation is called.

   • Visibility Timeout Period: the duration for which a message stays in the Inactive state after the message is received from the queue.

   • Message Retention Period: the maximum duration for which a message exists in the queue. After the specified retention period, the message is deleted regardless of whether the message is received.

   • Message Delay Period: the period after which all messages sent to the queue are consumed.

   • Enable Logging Feature: specifies whether to enable the logging feature.

   After the queue is created, it is displayed on the Queues page.

(Optional) Step 2: Create a bucket

If the desired bucket already exists, you can skip this step.

1. Log on to the OSS console.

2. In the left-side navigation pane, click Buckets.

3. On the Buckets page, click Create bucket.

4. In the Create bucket panel, configure the bucket parameters, and then click OK.

   • Bucket name: Enter event-notification-test.

   • Region: Select the same region as your queue.

   • Block public access: Select Off.

   • ACL: Select Public Read/Write.

     Note

     Keep the default values for other settings.

Step 3: Create a custom rule

When you create a rule, Simple Message Queue (SMQ) automatically creates a topic and subscription for the specified endpoint. You can manage these in the SMQ console.

1. Log on to the SMQ console.

2. In the left-side navigation pane, click Event Notifications.

3. In the top navigation bar, select a region.

4. On the Event Notifications page, click the OSS tab, and then click Create Rule.

5. In the Create rule - OSS panel, configure the following settings, and then click OK.

   • Instance Name: Enter a name for the rule.

   • Event Type: Select one or more event types.

   • Match rule: Configure the match rule.

     Note

     A match rule can be a full name, a prefix, a suffix, or a combination of a prefix and a suffix. Different rules cannot have overlapping resource definitions. An OSS resource is specified in the format bucket/object. For example, in the resource movie/hello.avi, movie is the bucket and hello.avi is the object.

     • Full Name: movie/hello.avi.

     • Prefix:

       • movie/hello: Matches all objects in the movie bucket that have the prefix hello.

       • movie/: Matches all objects in the movie bucket.

       • mov: Matches all objects in any bucket whose name has the prefix mov.

     • Suffix: .avi: Matches all objects in any bucket that have the suffix .avi.

     • Prefix and Suffix: Prefix movie/ and suffix .avi: Matches all objects in the movie bucket that have the suffix .avi.

   • Destination: Select Queue and enter the name of the queue that you created in Step 1.

Step 4: Upload an object

1. Log on to the OSS console.

2. In the left-side navigation pane, click Buckets.

3. On the Buckets page, click the name of the target bucket.

4. Choose Object management > Object list, and then click Upload object.

5. In the Upload object panel, specify the upload directory and object ACL, and then click Upload object. Upload objects by using the OSS console.

   The Status column displays "Uploaded".

Step 5: Receive messages

1. Log on to the SMQ console.

2. In the left-side navigation pane, choose Queue Model > Queues.

3. In the top navigation bar, select a region.

4. On the Queues page, find the target queue, and in the Action column, choose More > Send and receive messages.

5. On the Send and receive messages page, in the Receive messages section, click Receive message.

   The message list for the queue is displayed in the Receive messages section.

6. In the message list, find the target message, and then click Details in the Actions column to view its content in the Message details dialog box.