ファイルアップロードなどのイベントに応答するための EventBridge OSS トリガーの使用 - Function Compute

複数のオブジェクトプレフィックスとオブジェクトサフィックスを指定したり、単一の Object Storage Service (OSS) バケットに 10 個以上のトリガーを関連付けたりするには、EventBridge ベースの OSS トリガーを作成して、ファイルアップロードなどのイベントに応答します。

注意事項

EventBridge ベースの OSS トリガーとネイティブ OSS トリガーには、以下の違いがあります。

1 つのバケットに関連付けることができるネイティブ OSS トリガーは最大 10 個です。バケットにさらに多くの OSS トリガーを関連付けたい場合は、EventBridge ベースの OSS トリガーを使用できます。
説明
1 つのバケットに 10 個を超えるトリガーを関連付けることは推奨されません。さらにトリガーが必要な場合は、新しいバケットを作成してから、そのバケット用のトリガーを作成してください。

EventBridge のリソース制限と同様に、最大 50 個の EventBridge ベースの OSS トリガーを作成できます。詳細については、「制限事項」をご参照ください。
EventBridge ベースの OSS トリガーの場合、イベントタイプ、オブジェクトプレフィックス、および オブジェクトのサフィックス の組み合わせは一意である必要はありません。
オブジェクトプレフィックス と オブジェクトのサフィックス には複数の値を設定できます。ただし、オブジェクトプレフィックス と オブジェクトのサフィックス では、あいまい一致と正規表現マッチングはサポートされていません。
EventBridge ベースの OSS トリガーは、作成後すぐにアクティブになるわけではありません。作成後、関連付けられた関数をトリガーし始めるまでに約 30 秒かかります。

例

プレフィックスとして source と test、サフィックスとして .rar と .zip を指定するルールで OSS トリガーを設定できます。.rar または .zip サフィックスを持つ圧縮ファイルが、指定された OSS バケットの source または test ディレクトリにアップロードされると、関数が自動的にトリガーされます。関数が実行された後、解凍されたファイルは同じバケット内の別のディレクトリに保存されます。

前提条件

EventBridge
- EventBridge のアクティブ化と権限付与
Function Compute
- 関数の作成

Object Storage Service (OSS)
- バケットの作成

ステップ 1: EventBridge OSS トリガーの作成

Function Compute コンソールにログインします。左側のナビゲーションウィンドウで、[関数管理] > [関数]を選択します。
上部のナビゲーションバーでリージョンを選択し、[関数] ページで目的の関数をクリックします。
関数の詳細ページで、トリガー タブをクリックし、次に トリガーの作成 をクリックします。

トリガータイプ パネルで、クラウド製品のイベントトリガー を Object Storage Service (OSS) に設定し、OK の下で他のパラメーターを設定してから、[OK] をクリックします。

パラメーター	操作	例
名前	トリガーのカスタム名を入力します。	oss-trigger
バージョンまたはエイリアス	デフォルト値は LATEST です。別のバージョンまたはエイリアスのトリガーを作成する場合は、まず関数詳細ページのバージョンまたはエイリアスドロップダウンリストからバージョンまたはエイリアスを選択します。バージョンとエイリアスの詳細については、「バージョンの管理」および「エイリアスの管理」をご参照ください。	LATEST
バケット名	作成した OSS バケットを選択します。	bucket-zh****
オブジェクトプレフィックス	一致させたいオブジェクト名のプレフィックスを入力します。Function Compute では、循環呼び出しや予期しない課金を防ぐために、プレフィックスとサフィックスを設定することを推奨しています。 + Add Object Prefix をクリックして、オブジェクトプレフィックスに複数の値を追加できます。重要オブジェクトプレフィックスはスラッシュ (`/`) で始めることはできません。そうしないと、トリガーが起動されません。	source test
オブジェクトのサフィックス	一致させたいオブジェクト名のサフィックスを入力します。Function Compute では、循環呼び出しや予期しない課金を防ぐために、プレフィックスとサフィックスを設定することを推奨しています。 [+ オブジェクトサフィックスの追加] をクリックして、オブジェクトのサフィックスに複数の値を追加できます。	png
イベントタイプ	1 つ以上のトリガーイベントを選択します。Function Compute のイベントタイプの詳細については、「OSS イベントの定義」をご参照ください。	`oss:ObjectCreated:PutObject`、`oss:ObjectCreated:PostObject`、`oss:ObjectCreated:CompleteMultipartUpload`
イベントパターンの内容	オブジェクトプレフィックス、オブジェクトのサフィックス、およびイベントタイプを設定すると、システムがこのパラメーターを自動的に入力します。重要イベントパターンの内容は慎重に変更してください。誤って変更すると、トリガーが失敗する可能性があります。イベントパターンを変更する前に、ルールを理解しておいてください。詳細については、「イベントパターン」をご参照ください。	`{ "source":[ "acs.oss" ] }`
呼び出しメソッド	関数を呼び出すメソッドを選択します。デフォルトのメソッドは同期呼び出しです。同期呼び出し: Function Compute は関数をトリガーし、実行が完了するのを待ってから結果を返します。この方法は、幅広いユースケースに適しています。詳細については、「同期呼び出し」をご参照ください。非同期呼び出し：Function Compute は関数をトリガーして、すぐに応答を返します。サービスは、関数が少なくとも 1 回実行されることを保証しますが、実行結果は返しません。このメソッドは、実行時間が長い関数に適しています。詳細については、「非同期呼び出し」をご参照ください。	同期呼び出し
トリガーの有効化のステータス	トリガーを作成直後に有効にするかどうかを指定します。デフォルトでは、トリガーを有効にするが選択されており、作成後すぐにトリガーが有効になります。	N/A
プッシュ形式	関数のイベント入力パラメーターのデータ形式を指定します。 CloudEvents: イベントデータを共通の形式で記述するための仕様です。イベントとそのペイロードの説明が含まれており、サービスやプラットフォーム間でのイベントの宣言と配信を簡素化します。 RawData: CloudEvents 形式の他のメタデータなしで、イベントペイロードのみを配信します。説明ネイティブ OSS トリガーは EventBridge ベースの OSS トリガーとは異なります。ネイティブ OSS トリガーのイベントパラメーターは、OSS によって生成されるイベント形式である OSSEvents テンプレートのみをサポートします。	CloudEvents

リトライやデッドレター設定などの高度なパラメーターについては、「高度なトリガー機能」をご参照ください。

トリガーが作成されると、[トリガー名] リストに表示されます。トリガーを修正または削除するには、「トリガーの管理」をご参照ください。

ステップ 2: 関数入力パラメーターの設定

EventBridge ベースの OSS トリガーは、イベントを CloudEvents 形式の入力パラメーターとして関数に渡します。手動でイベントを関数に渡してトリガーをシミュレートできます。

関数詳細ページの[コード] タブで、[関数をテスト] の横にあるアイコンをクリックし、ドロップダウンリストから [テストパラメーターの設定] を選択します。

テストパラメーターの設定 パネルで、新規テストイベントの作成 または 既存のテストイベントの変更 を選択します。イベント名とイベント内容を入力し、OK をクリックします。

イベントは Function Compute の入力パラメーターです。対象の OSS バケットで指定されたイベントが発生すると、システムはイベントデータを JSON 形式でバインドされた関数に送信します。以下のコードは例です。

{
    "datacontenttype": "application/json;charset=utf-8",
    "aliyunaccountid": "143199913****",
    "data": {
        "eventVersion": "1.0",
        "responseElements": {
            "requestId": "6364D216511B143733C5A67B"
        },
        "eventSource": "acs:oss",
        "eventTime": "2023-11-04T08:49:26.000Z",
        "requestParameters": {
            "sourceIPAddress": "140.205.XX.XX"
        },
        "eventName": "ObjectCreated:PutObject",
        "userIdentity": {
            "principalId": "143199913****"
        },
        "region": "cn-hangzhou",
        "oss": {
            "bucket": {
                "name": "bucket-zh***",
                "arn": "acs:oss:cn-hangzhou:143199913****:bucket-zh***",
                "virtualBucket": "",
                "ownerIdentity": "143199913****"
            },
            "ossSchemaVersion": "1.0",
            "object": {
                "size": 13,
                "objectMeta": {
                    "mimeType": "text/plain"
                },
                "deltaSize": 13,
                "eTag": "59CA0EFA9F5633CB0371BBC0355478D8",
                "key": "source/a.png"
            }
        }
    },
    "subject": "acs:oss:cn-hangzhou:143199913****:bucket-zh***/source/a.png",
    "aliyunoriginalaccountid": "143199913****",
    "source": "acs.oss",
    "type": "oss:ObjectCreated:PutObject",
    "aliyunpublishtime": "203-11-04T08:49:26.745Z",
    "specversion": "1.0",
    "aliyuneventbusname": "default",
    "id": "6364D216511B143733C5A67B",
    "time": "2023-11-04T08:49:26Z",
    "aliyunregionid": "cn-hangzhou"
}

次の表に、イベントパラメーターのフィールドを説明します。

パラメーター	タイプ	例	説明
datacontenttype	string	application/json;charset=utf-8	data パラメーターのコンテンツタイプ。datacontenttype パラメーターは application/json;charset=utf-8 のみをサポートします。
aliyunaccountid	string	143199913****	ご使用の Alibaba Cloud アカウントの ID。Function Compute コンソールの概要ページの参考情報セクションで確認できます。
data	struct	{}	OSS イベントのコンテンツで、JSON オブジェクトです。CloudEvents には、イベント発生時に OSS によって定義されるコンテキストが含まれています。この情報は data パラメーターにカプセル化されています。
subject	string	acs:oss:cn-hangzhou:143199913**:bucket-zh**/source/a.png	イベントの件名。形式は `acs:oss:<region>:<your_account_id>:<your_bucket>` です。ここで、`<region>` は関数のリージョン、`<your_account_id>` はご利用の Alibaba Cloud アカウント ID、`<your_bucket>` はご利用のバケット名です。
aliyunoriginalaccountid	string	143199913****	イベントを発信した Alibaba Cloud アカウントの ID。
source	string	acs.oss	イベントソース。OSS トリガーの場合、値は `acs.oss` に固定されます。
type	string	oss:ObjectCreated:PutObject	イベントタイプ。
aliyunpublishtime	timestamp	2023-11-04T08:49:26.745Z	イベントが受信された時刻。
specversion	string	1.0	CloudEvents プロトコルのバージョン。
aliyuneventbusname	string	default	イベントを受信するイベントバスの名前。
id	string	6364D216511B143733C5A67B	イベント ID。
time	timestamp	2023-11-04T08:49:26Z	イベントが発生した時刻。
aliyunregionid	string	cn-hangzhou	イベントが受信されたリージョン。
aliyunpublishaddr	string	140.205.XX.XX	イベントを受信するサーバーの IP アドレス。

data パラメーターの以下のフィールドを、ご利用の環境に合わせて更新する必要があります。

userIdentity.principalId: ご利用の Alibaba Cloud アカウント ID に置き換えます。
region: 関数を作成したリージョンに置き換えます。
oss.bucket.name: ご利用のバケット名に置き換えます。バケットは関数と同じリージョンにある必要があります。
oss.bucket.arn: 形式は acs:oss:<region>:<your_account_id>:<your_bucket> です。ここで、<region> は関数のリージョン、<your_account_id> はご利用の Alibaba Cloud アカウント ID、<your_bucket> は同じリージョンにあるご利用のバケット名です。
oss.bucket.ownerIdentity: ご利用の Alibaba Cloud アカウント ID に置き換えます。
object.key: 宛先バケットにアップロードしたオブジェクトに置き換えます。

重要

イベントパラメーターを設定してトリガーをシミュレートする場合、このチュートリアルの source/a.png のように、指定したオブジェクトが設定済みのバケットに存在することを確認してください。そうしないと、関数がトリガーされないか、実行が失敗します。

ステップ 3: 関数コードの記述とテスト

OSS トリガーを作成した後、関数コードを記述してテストし、その正当性を検証します。その後、関数は実際の OSS イベントによって自動的にトリガーされます。

警告

コード内でループトリガーを避ける必要があります。そうしないと、予期しない課金が発生する可能性があります。典型的なループトリガーのシナリオは、OSS バケットへのオブジェクトアップロードが関数をトリガーし、その関数が 1 つ以上のファイルを生成して同じバケットに書き戻し、それが再び関数をトリガーする場合です。詳細については、「OSS トリガーのルール」をご参照ください。

関数詳細ページの コード タブで、エディターにコードを入力し、デプロイメントコード をクリックします。

次のセクションでは、準備とサンプルコードについて説明します。

説明

関数内で OSS リソースの読み取りまたは書き込みを行う必要がある場合は、インターネットトラフィックと関連料金を避けるために、OSS 内部エンドポイントを使用することを推奨します。OSS 内部エンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。

Node.js

/* 事前準備:
1. ターミナルで次のコマンドを実行して package.json ファイルを作成し、jimp モジュールをインストールします。
  a. npm init を実行して package.json ファイルを作成します。
  b. npm install jimp を実行して jimp モジュールをインストールします。
2. 関数ハンドラが index.handler であることを確認します。
*/

'use strict';
 console.log('Loading function ...');
 var oss = require('ali-oss');
 var fs = require('fs');
 var jimp = require("jimp");
 module.exports.handler = function (eventBuf, ctx, callback) {
     console.log('Received event:', eventBuf.toString());
     var event = JSON.parse(eventBuf);

     var ossEvent = event.data;

     // OSS リージョンには "oss-" というプレフィックスが付きます。例: oss-cn-shanghai
     var ossRegion = "oss-" + ossEvent.region;
     // OSS クライアントを作成します。
     var client = new oss({
         region: ossRegion,
         /*
         Alibaba Cloud アカウントの AccessKey ペアは、すべての API へのアクセスを許可します。セキュリティのため、API 呼び出しや日常の O&M には RAM ユーザーを使用してください。
         コードに AccessKey ID とシークレットをハードコーディングしないでください。漏洩につながり、アカウントのセキュリティを損なう可能性があります。
         この例では、コンテキストから認証情報を取得します。
         */
         accessKeyId: ctx.credentials.accessKeyId,
         accessKeySecret: ctx.credentials.accessKeySecret,
         stsToken: ctx.credentials.securityToken
     });
     // イベントからバケット名を取得します。
     client.useBucket(ossEvent.oss.bucket.name);
     // 処理されたイメージは processed/ ディレクトリに保存されます。
     var newKey = ossEvent.oss.object.key.replace("source/", "processed/");
     var tmpFile = "/tmp/processed.png";
     // OSS オブジェクトを取得します。
     console.log('Getting object: ', ossEvent.oss.object.key)
     client.get(ossEvent.oss.object.key).then(function (val) {
         // キャッシュから OSS オブジェクトのコンテンツを読み取ります。
         jimp.read(val.content, function (err, image) {
             if (err) {
                 console.error("Failed to read image");
                 callback(err);
                 return;
             }
             // イメージのサイズを変更し、tmp ファイルに保存します。
             image.resize(128, 128).write(tmpFile, function (err) {
                 if (err) {
                     console.error("Failed to write image locally");
                     callback(err);
                     return;
                 }
                 // 読み取った OSS オブジェクトを OSS バケットにアップロードし、オブジェクトの名前を変更します。
                 console.log('Putting object: ', newKey);
                 client.put(newKey, tmpFile).then(function (val) {
                     console.log('Put object:', val);
                     callback(null, val);
                     return;
                 }).catch(function (err) {
                     console.error('Failed to put object: %j', err);
                     callback(err);
                     return
                 });
             });
         });
     }).catch(function (err) {
         console.error('Failed to get object: %j', err);
         callback(err);
         return
     });
 };

Python

# 事前準備:
# 1. 関数に設定されたロールに OSS へのアクセス権限があることを確認します。RAM コンソールにログインして、ロールに必要な権限を付与できます。
# 2. 関数のリクエストハンドラが index.handler であることを確認します。

# -*- coding: utf-8 -*-
import oss2, json
from wand.image import Image
def handler(event, context):
    evt = json.loads(event)
    creds = context.credentials
    # OSS SDK に必要
    # Alibaba Cloud アカウントの AccessKey ペアは、すべての API へのアクセスを許可します。セキュリティのため、API 呼び出しや日常の O&M には RAM ユーザーを使用してください。
    # コードに AccessKey ID とシークレットをハードコーディングしないでください。漏洩につながり、アカウントのセキュリティを損なう可能性があります。
    # この例では、コンテキストから認証情報を取得します。
    auth=oss2.StsAuth(
        creds.access_key_id,
        creds.access_key_secret,
        creds.security_token)
    evt = evt['data']
    bucket_name = evt['oss']['bucket']['name']
    endpoint = 'oss-' +  evt['region'] + '-internal.aliyuncs.com'
    bucket = oss2.Bucket(auth, endpoint, bucket_name)
    objectName = evt['oss']['object']['key']
    # 処理されたイメージは processed/ に保存されます
    newKey = objectName.replace("source/", "processed/")
    remote_stream = bucket.get_object(objectName)
    if not remote_stream:
        return
    remote_stream = remote_stream.read()
    with Image(blob=remote_stream)  as img:
        with img.clone() as i:
            i.resize(128, 128)
            new_blob = i.make_blob()
            bucket.put_object(newKey, new_blob)

PHP

/* 事前準備:
1. 関数に設定されたロールに OSS へのアクセス権限があることを確認します。RAM コンソールにログインして、ロールに OSS へのアクセス権限を付与できます。
2. 関数のリクエストハンドラが index.handler であることを確認します。
*/

<?php
  use OSS\OssClient;
function handler($event, $context) {
  $event           = json_decode($event, $assoc = true);
  /*
    Alibaba Cloud アカウントの AccessKey ペアは、すべての API へのアクセスを許可します。セキュリティのため、API 呼び出しや日常の O&M には RAM ユーザーを使用してください。
    コードに AccessKey ID とシークレットをハードコーディングしないでください。漏洩につながり、アカウントのセキュリティを損なう可能性があります。
    この例では、コンテキストから認証情報を取得します。
  */
  $accessKeyId     = $context["credentials"]["accessKeyId"];
  $accessKeySecret = $context["credentials"]["accessKeySecret"];
  $securityToken   = $context["credentials"]["securityToken"];
  $evt        = $event['data'];
  $bucketName = $evt['oss']['bucket']['name'];
  $endpoint   = 'oss-' . $evt['region'] . '-internal.aliyuncs.com';
  $objectName = $evt['oss']['object']['key'];
  $newKey = str_replace("source/", "processed/", $objectName);
  try {
    $ossClient = new OssClient($accessKeyId, $accessKeySecret, $endpoint, false, $securityToken);
    $content = $ossClient->getObject($bucketName , $objectName);
    if ($content == null || $content == "") {
      return;
    }
    $imagick = new Imagick();
    $imagick->readImageBlob($content);
    $imagick->resizeImage(128, 128, Imagick::FILTER_LANCZOS, 1);
    $ossClient->putObject($bucketName, $newKey, $imagick->getImageBlob());
  } catch (OssException $e) {
    print($e->getMessage());
  }
}

Java

/* 事前準備:
1. pom.xml に次の依存関係を追加します。
<dependencies>
    <dependency>
      <groupId>com.aliyun.fc.runtime</groupId>
      <artifactId>fc-java-core</artifactId>
      <version>1.4.1</version>
    </dependency>
    <dependency>
      <groupId>com.aliyun.fc.runtime</groupId>
      <artifactId>fc-java-event</artifactId>
      <version>1.2.0</version>
    </dependency>
</dependencies>
2. 関数ハンドラが example.App::handleRequest であることを確認します。
*/

package example;

import java.io.*;
import java.util.Map;

import com.aliyun.fc.runtime.Context;
import com.aliyun.fc.runtime.StreamRequestHandler;
import com.aliyun.fc.runtime.event.OSSEvent.Event;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;



public class App implements StreamRequestHandler {

    private static final ObjectMapper mapper = new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    public static final class CloudEvent {
        public final String id;

        public final String source;
        public final String specversion;

        public final String type;
        public final String datacontenttype;

        public final String dataschema;

        public final String subject;

        public final String time;

        public final Map<String, ?> extensions;

        public final Event data;

        @JsonCreator
        public CloudEvent(@JsonProperty("id") String id, @JsonProperty("source") String source, @JsonProperty("specversion") String specversion, @JsonProperty("type") String type, @JsonProperty("datacontenttype") String datacontenttype, @JsonProperty("dataschema") String dataschema, @JsonProperty("subject") String subject, @JsonProperty("time") String time, @JsonProperty("extensions") Map<String, ?> extensions, @JsonProperty("data") Event data) {
            this.id = id;
            this.source = source;
            this.specversion = specversion;
            this.type = type;
            this.datacontenttype = datacontenttype;
            this.dataschema = dataschema;
            this.subject = subject;
            this.time = time;
            this.extensions = extensions;
            this.data = data;
        }

        public String getId() {
            return this.id;
        }

        public String getSource() {
            return this.source;
        }

        public String getSpecversion() {
            return this.specversion;
        }

        public String getType() {
            return this.type;
        }

        public String getDatacontenttype() {
            return this.datacontenttype;
        }

        public String getDataschema() {
            return this.dataschema;
        }

        public String getSubject() {
            return this.subject;
        }

        public String getTime() {
            return this.time;
        }

        public Map<String, ?> getExtensions() {
            return this.extensions;
        }

        public Event getData() {
            return this.data;
        }
    }
    @Override
    public void handleRequest(
            InputStream inputStream, OutputStream outputStream, Context context) throws IOException {
        CloudEvent cloudEvents = mapper.readValue(inputStream, new TypeReference<CloudEvent>() {});
        Event ossEvent = cloudEvents.getData();
        context.getLogger().info(String.format("received %s from %s @ %s", ossEvent.eventName, ossEvent.eventSource, ossEvent.region));
        outputStream.write(String.format("received %s from %s @ %s", ossEvent.eventName, ossEvent.eventSource, ossEvent.region).getBytes());
        outputStream.write(String.format("received bucket %s", ossEvent.oss.bucket.arn).getBytes());
        outputStream.write(String.format("received object %s and it's size is %s", ossEvent.oss.object.key, ossEvent.oss.object.size).getBytes());
    }
}

関数のテスト をクリックします。
実行が完了すると、コード タブの上部で結果を表示できます。

Function Compute:EventBridge OSS トリガーの設定

注意事項

例

前提条件

ステップ 1: EventBridge OSS トリガーの作成

ステップ 2: 関数入力パラメーターの設定

ステップ 3: 関数コードの記述とテスト

よくある質問

関連トピック