OSS事件触发器

对象存储服务（Object Storage Service，简称OSS）是阿里云提供的海量、安全、低成本、高可靠的云存储服务。您可以使用HTTP RESTful API在互联网任何位置存储和访问数据。

阿里云对象存储和函数计算无缝集成。您可以为各种类型的事件设置处理函数，当OSS系统捕获到指定类型的事件后，会自动调用函数处理。例如，您可以设置函数来处理PutObject事件，当您调用OSS PutObject API上传图片到OSS后，相关联的函数会自动触发来处理该图片。如下图所示，您可以实现图像/语音处理函数，自由的调用各种服务处理图像/音频数据，再把结果写回到多种存储服务中。整个架构中，您只需要专注于函数逻辑的编写，系统将以实时的、可靠的、大规模并行的方式处理海量的数据。

注意：

使用 OSS 触发器一定要避免循环触发。一个典型的循环触发场景是 OSS 的某个 Bucket 上传文件触发函数执行，这个函数又生成了一个或多个文件，写回到 OSS 的 Bucket 里，这个写入动作又触发了函数执行，形成了链状循环。

上述过程类似于一个无限递归，为了避免这种循环触发函数产生不必要的费用，强烈建议您配置前/后缀，例如将触发函数的 Bucket 目录前缀设置成 src/，生成的文件写入的目录前缀设置为 dst/ ，这样生成的文件就不会再次触发函数。

OSS事件定义

当OSS系统捕获到相关事件后，会将事件信息编码为JSON字符串，传递给事件处理函数OSS当前的事件触发类型如下表所示。

注意：一个 bucket 最多只能创建 10 个触发规则事件。

OSS 事件格式示例

OSS事件在触发函数执行时，会以此格式作为函数的输入参数event，您可以在代码中获取事件信息。有关更多event信息，请参考函数的输入参数event。

在Node.js runtime中获取Bucket名称的函数代码示例如下：

module.exports.handler = function(event, context, callback) { 
  var event = JSON.parse(event);
  var bucketName = event.events[0].oss.bucket.name;
  console.log('bucketName: '+ bucketName);
  callback(null, bucketName); 
};

{
  "events": [
    {
      "eventName": "ObjectCreated:PutObject",
      "eventSource": "acs:oss",
      "eventTime": "2017-04-21T12:46:37.000Z",
      "eventVersion": "1.0",
      "oss": {
        "bucket": {
          "arn": "acs:oss:cn-shanghai:123456789:bucketname",
          "name": "testbucket",
          "ownerIdentity": "123456789",
          "virtualBucket": ""
        },
        "object": {
          "deltaSize": 122539,
          "eTag": "688A7BF4F233DC9C88A80BF985AB7329",
          "key": "image/a.jpg",
          "size": 122539
        },
        "ossSchemaVersion": "1.0",
        "ruleId": "9adac8e253828f4f7c0466d941fa3db81161e853"
      },
      "region": "cn-shanghai",
      "requestParameters": {
        "sourceIPAddress": "140.205.128.221"
      },
      "responseElements": {
        "requestId": "58F9FF2D3DF792092E12044C"
      },
      "userIdentity": {
        "principalId": "123456789"
      }
    }
  ]
}

配置OSS事件触发器

触发器示例

oss_events_trigger.yml

triggerConfig:
    events:
        - oss:ObjectCreated:PostObject
        - oss:ObjectCreated:PutObject
    filter:
        key:
            prefix: source/

触发器参数说明

• events：OSS事件类型
• filter：filter为OSS对象过滤参数，满足过滤条件的OSS对象才可以触发函数，包含如下属性：
  • key：过滤器支持过滤对象键（Key），包含如下属性：
    • prefix：匹配前缀
    • suffix：匹配后缀

一个 Bucket 的不同触发器如果指定了相同的事件类型，则前缀和后缀不能重叠。假如一个触发器配置了oss:ObjectCreated:PutObject事件，source前缀和zip后缀。下面列出了是否可以给该 Bucket 配置其它触发器：

说明：

如果您需要让一个触发器触发多个函数，可以结合使用函数计算和函数工作流服务。先通过触发器触发一个函数，该函数启动函数工作流流程，在流程里您可以调用多个函数。具体使用可以参见示例。

使用示例

可以通过函数计算控制台（推荐）、Fun（推荐）、命令行工具fcli和SDK四种方式设置函数的OSS事件触发器，下面对这三种方式分别进行介绍：

示例 1. 控制台新建OSS事件触发器

本示例展示了使用控制台设置OSS事件触发器的方式。可以在创建函数的时候设置触发器，也可以在函数创建完成后再设置触发器。

对触发器有困惑的同学可以参考文档使用事件源服务。

首先登录函数计算管理控制台，选择相应的区域和服务。如果还未新建服务，请参考创建服务。

在创建函数时设置触发器

1. 单击创建函数，进入创建函数页面，选择空白函数，单击下一步。

2. 选择OSS事件触发器，并按下图进行配置

   

3. 创建函数，填写相应信息，选择在线编辑，并粘贴以下python runtime的函数示例代码，单击下一步。

    # -*- coding: utf-8 -*-
    import json
    import logging  
    def handler(event, context):
      logger = logging.getLogger()
      eventObj = json.loads(event)["events"]
      logger.info("eventName: %s" % eventObj[0]["eventName"])
      logger.info("bucketName: %s" % eventObj[0]["oss"]["bucket"]["name"])
      return "success"

4. （可选）配置权限，单击下一步，核对信息无误后，单击创建。

在函数创建完成后设置触发器

1. 选中已有的函数，单击 触发器 > 创建触发器。

2. 在创建触发器页面，按下图配置 对象存储触发器，单击 确定。

   

示例 2. Fun 新建OSS事件触发器

Fun 提供了 OSS 触发器 的支持，可以实现函数触发器的创建与更新。下面，我们介绍使用 Fun 配置 OSS 触发器的步骤。

在项目根目录创建一个 template.yml 文件，并将内容填充为：

ROSTemplateFormatVersion: '2015-09-01'
Transform: 'Aliyun::Serverless-2018-04-03'
Resources:
  FunDemo:
    Type: 'Aliyun::Serverless::Service'
    ossdemo:
      Type: 'Aliyun::Serverless::Function'
      Properties:
        Handler: index.handler
        Runtime: python2.7
        CodeUri: './'
      Events:
        oss-trigger-name:
          Type: OSS # trigger type
          Properties:
            BucketName: ossdemobucket # oss bucket name
            Events:
              - oss:ObjectCreated:*
              - oss:ObjectRemoved:DeleteObject        
            Filter: 
              Key:
                Prefix: source/
                Suffix: .png

在项目根目录创建一个 index.js，然后编写相应的逻辑代码就可以了。代码编写完成，直接执行 fun deploy 即可实现部署。完整的示例请参考。

如果想在本地单步调试、运行函数，可以参考 开发函数计算的正确姿势 —— 使用 Fun Local 本地运行与调试。

更多的配置规则 请参考。

Fun 的更多教程 请参考 。

示例 3. fcli 新建OSS事件触发器

首先，创建一个包含Trigger Config的yaml文件，config.yaml。例如，有对象以put或post方式上传到对应的bucket下的source/目录下，触发函数运行的yaml文件内容如下：

triggerConfig:
    events:
        - oss:ObjectCreated:PostObject
        - oss:ObjectCreated:PutObject
    filter:
        key:
            prefix: source/

在对应的函数目录下创建触发器

mkt test_oss_trigger -t oss -r acs:ram::account_id:role/AliyunOSSEventNotificationRole -s acs:oss:cn-region:account_id:bucketName -c config.yaml

• -r —invocation-role string设置触发角色。
• -s —source-arn string事件源的资源符号，例如acs:oss:cn-shanghai:12345678:myBucketName。
• -c —trigger-config string设置trigger配置文件。
• -t —type string 触发器类型，默认是oss。

更多fcli使用，请参考fcli开发指南。

示例 4. SDK编程新建OSS事件触发器

client = fc2.Client(
    endpoint='<Your Endpoint>',
    accessKeyID='<Your AccessKeyID>',
    accessKeySecret='<Your AccessKeySecret>')
service_name = 'serviceName'
function_name = 'functionName'
trigger_name = 'triggerName'
trigger_type = 'oss'
source_arn = 'acs:oss:{0}:{1}:{2}'.format('<region>', '<account_id>', '<self.code_bucket>')
invocation_role = 'acs:ram::<Your Account ID>:role/<Your Invocation Role>'
trigger_config = {
            'events': ['oss:ObjectCreated:*'],
            'filter': {
                'key': {
                    'prefix': 'source',
                }
            }
        }
client.create_trigger(service_name, function_name, trigger_name, trigger_type, trigger_config, source_arn, invocation_role)