tencent cloud

Serverless Cloud Function

Release Notes and Announcements
Release Notes
Announcements
User Guide
Product Introduction
Overview
Related Concepts
How It Works
Strengths
Scenarios
Related Products
Purchase Guide
Billing Overview
Billing Mode
Billable Items and Billing Modes
Function Computing Power Support
Free Tier
SCF Pricing
Billing Example
Payment Overdue
Getting Started
Creating Event Function in Console
User Guide
Quota Management
Managing Functions
Web Function Management
Log Management
Concurrence Management
Trigger Management
Function URL
A Custom Domain Name
Version Management
Alias Management
Permission Management
Running Instance Management
Plugin Management
Managing Monitors and Alarms
Network Configuration
Layer Management
Execution Configuration
Extended Storage Management
DNS Caching Configuration
Resource Managed Mode Management
Near-Offline Resource Hosting Model
Workflow
Triggers
Trigger Overview
Trigger Event Message Structure Summary
API Gateway Trigger
COS Trigger
CLS Trigger
Timer Trigger
CKafka Trigger
Apache Kafka Trigger
MQTT Trigger
Trigger Configuration Description
MPS Trigger
CLB Trigger Description
TencentCloud API Trigger
Development Guide
Basic Concepts
Testing a Function
Environment Variables
Dependency Installation
Using Container Image
Error Types and Retry Policies
Dead Letter Queue
Connecting SCF to Database
Automated Deployment
Cloud Function Status Code
Common Errors and Solutions
Developer Tools
Serverless Web IDE
Calling SDK Across Functions
Third-Party Tools
Code Development
Python
Node.js
Golang
PHP
Java
Custom Runtime
Deploying Image as Function
Web Framework Development
Deploying Framework on Command Line
Quickly Deploying Egg Framework
Quickly Deploying Express Framework
Quickly Deploying Flask Framework
Quickly Deploying Koa Framework
Quickly Deploying Laravel Framework
Quickly Deploying Nest.js Framework
Quickly Deploying Next.js Framework
Quickly Deploying Nuxt.js Framework
Quickly Deploying Django Framework
Use Cases
Overview
Solutions with Tencent Cloud Services
Business Development
TRTC Practices
COS Practices
CKafka Practice
CLS
CLB Practice
MPS
CDN
CDWPG
VOD
SMS
ES
Scheduled Task
Video Processing
Success Stories
Tencent Online Education
Online Video Industry
Tencent Online Education
Best Practice of Tencent IEG Going Global
API Documentation
History
Introduction
API Category
Making API Requests
Other APIs
Namespace APIs
Layer Management APIs
Async Event Management APIs
Trigger APIs
Function APIs
Function and Layer Status Description
Data Types
Error Codes
SDK Documentation
FAQs
General
Web Function
Billing FAQs
Network FAQs
Log FAQs
SCF utility class
Event Handling FAQs
API Gateway Trigger FAQs
Related Agreement
Service Level Agreement
Contact Us
Glossary
ドキュメントServerless Cloud FunctionTriggersCOS TriggerCOS Trigger Description

COS Trigger Description

PDF
フォーカスモード
フォントサイズ
最終更新日: 2024-12-02 19:58:17
You can write an SCF function to handle object creation and deletion events in a COS bucket. COS can publish events to the function and invoke it by using the event data as parameters. You can add a bucket notification configuration in the COS bucket, which can identify information such as the trigger event type and name of the function to be invoked.
Characteristics of COS triggers:
Push model COS monitors the specified bucket action (event type) and invokes the associated function to push the event data to the function. In the push model, the bucket notification is used to store the event source mapping with COS.
Async invocation A COS trigger always invokes a function asynchronously, and the result is not returned to the invoker. For more information on invocation types, see "Invocation Types" in How It Works.

COS Trigger Attributes

COS bucket (required): The configured COS bucket, which can only be a COS bucket in the same region.
Event type (required): It supports "file upload" and "file deletion" as well as finer-grained upload and deletion events. For specific event types, see the table below. The event type determines when the trigger triggers the function. For example, if "File upload" is selected, the function will be triggered when there is a file uploaded to the COS bucket.
Event Type
Description
cos:ObjectCreated:*
All upload events mentioned below can trigger the function.
cos:ObjectCreated:Put
The function will be triggered when a file is created through the `Put Object` API.
cos:ObjectCreated:Post
The function will be triggered when a file is created through the `Post Object` API.
cos:ObjectCreated:Copy
The function will be triggered when a file is created through the `Put Object - Copy` API.
cos:ObjectCreated:CompleteMultipartUpload
The function will be triggered when a file is created through the `CompleteMultipartUpload` API.
cos:ObjectCreated:Origin
The function will be triggered when an object is created through COS origin-pull.
cos:ObjectCreated:Replication
The function will be triggered when an object is created through cross-region replication.
cos:ObjectRemove:*
All deletion events mentioned below can trigger the function.
cos:ObjectRemove:Delete
The function will be triggered when an object in a bucket for which versioning is not enabled is deleted through the `Delete Object` API, or an object on a specified version is deleted with `versionid`.
cos:ObjectRemove:DeleteMarkerCreated
The function will be triggered when an object in a bucket for which versioning is enabled or suspended is deleted through the `Delete Object` API.
cos:ObjectRestore:Post
The function will be triggered when an archive restoration job is created.
cos:ObjectRestore:Completed
The function will be triggered when an archive restoration job is completed.
Prefix filtering (optional): Prefix filtering is usually used to filter file events in a specified directory. For example, if the prefix to be filtered is test/, only file events in the test/ directory can trigger the function, while those in the hello/ directory cannot.
Suffix filtering (optional): Suffix filtering is usually used to filter file events in a specified type or with a specified suffix. For example, if the suffix to be filtered is .jpg, only file events of the .jpg type can trigger the function, while those of the .png/ type cannot.

COS Trigger Use Limits

In order to avoid errors in COS event production and delivery, for the combination of each event (such as file upload/deletion) and prefix/suffix filter in each bucket, COS limits that the same rule can be bound to only one function that can be triggered. Therefore, when you create a COS trigger, do not configure repeated rules for the same COS bucket. For example, if you configure a Created: * event trigger in the test bucket for function A (with no filter rule configured), then the upload events (including Created:Put and Created:Post) in the test bucket cannot be bound to other functions, but you can configure an ObjectRemove event trigger in the test bucket for function B.
When using prefix and suffix filter rule, in order to ensure the uniqueness of the triggering events in the same bucket, it should be noted that the same bucket cannot use overlapping prefixes, overlapping suffixes, or overlapping combinations of prefixes and suffixes to define the filter rule for the same event type. For example, if you configure a Created: * trigger event with prefix filter of Log in the test bucket for function A, then you cannot configure a Created: * trigger event with prefix filter of Log in the test bucket.
In addition, COS triggers can only trigger functions in the same region; for example, for an SCF function created in the Guangzhou region, you can only select a COS bucket in the Guangzhou region (South China) when configuring a COS trigger. If you want to trigger a function through COS bucket events in a specific region, create a function in that region.
A COS trigger has limits in two dimensions: SCF and COS, as detailed below:
SCF dimension: One function can be bound to 10 COS triggers at most.
COS dimension: Only one function can be bound to the same event and prefix/suffix rules in a single COS bucket.

Event Message Structure for COS Trigger

When an object creation or deletion event occurs in the specified COS bucket, event data will be sent to the bound function in JSON format as shown below.
{
    "Records": [{
        "cos": {
            "cosSchemaVersion": "1.0",
            "cosObject": {
                "url": "http://testpic-1253970026.cos.ap-chengdu.myqcloud.com/testfile",
                "meta": {
                    "x-cos-request-id": "NWMxOWY4MGFfMjViMjU4NjRfMTUyMVxxxxxxxxx=",
                    "Content-Type": "",
                    "x-cos-meta-mykey": "myvalue"
                },
                "vid": "",
                "key": "/1253970026/testpic/testfile",
                "size": 1029
            },
            "cosBucket": {
                "region": "cd",
                "name": "testpic",
                "appid": "1253970026"
            },
            "cosNotificationId": "unkown"
        },
        "event": {
            "eventName": "cos:ObjectCreated:*",
            "eventVersion": "1.0",
            "eventTime": 1545205770,
            "eventSource": "qcs::cos",
            "requestParameters": {
                "requestSourceIP": "192.168.15.101",
                "requestHeaders": {
                    "Authorization": "q-sign-algorithm=sha1&q-ak=xxxxxxxxxxxxxx&q-sign-time=1545205709;1545215769&q-key-time=1545205709;1545215769&q-header-list=host;x-cos-storage-class&q-url-param-list=&q-signature=xxxxxxxxxxxxxxx"
                }
            },
            "eventQueue": "qcs:0:scf:cd:appid/1253970026:default.printevent.$LATEST",
            "reservedInfo": "",
            "reqid": 179398952
        }
    }]
}
The data structures are as detailed below:
Structure
Description
Records
List structure. There may be multiple messages merged in the list.
event
This records the event information, including event version, event source, event name, time, queue information, request parameters, and request ID.
cos
This records the COS information corresponding to the event.
cosBucket
This records the bucket of the specific event, including bucket name, region, and user APPID (which can be obtained on the Account Info page).
cosObject
This records the object of the specific event, including object file path, size, custom metadata, and access URL.

Sample

The following is a sample COS trigger in Java for your reference:
https://github.com/tencentyun/scf-demo-java/blob/master/src/main/java/example/Cos.java

前の記事へ: Usage次の記事へ: Usage

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック