Contents：
1. API Description
Domain name for API request: scf.tencentcloudapi.com.
This API is used to create a trigger based on the input parameters.
A maximum of 100 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: scf.ap-shanghai-fsi.tencentcloudapi.com
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: CreateTrigger |
| Version | Yes | String | Common parameter. The value used for this API: 2018-04-16 |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| FunctionName | Yes | String | Name of the function bound to the new trigger |
| TriggerName | Yes | String | Name of a new trigger. For a timer trigger, the name can contain up to 100 letters, digits, dashes, and underscores; for a COS trigger, it should be an access domain name of the corresponding COS bucket applicable to the XML API (e.g., 5401-5ff414-12345.cos.ap-shanghai.myqcloud.com); for other triggers, please see the descriptions of parameters bound to the specific trigger. |
| Type | Yes | String | Trigger type. Currently, COS, CMQ, timer, and ckafka triggers are supported. |
| TriggerDesc | No | String | Parameter corresponding to the trigger. For a timer trigger, it should be a Linux cron expression; for a COS trigger, it should be a JSON string ({"event":"cos:ObjectCreated:*","filter":{"Prefix":"","Suffix":""}}), where event is the triggered COS event, Prefix in the filter is the corresponding file prefix filter, and Suffix is the corresponding suffix filter, and the filter can be left blank if not needed; for other triggers, please see the description of the specific trigger. |
| Namespace | No | String | Function namespace |
| Qualifier | No | String | Function version |
| Enable | No | String | Initial enabling status of the trigger. OPEN indicates enabled, and CLOSE indicates disabled. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TriggerInfo | Trigger | Trigger information |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Creating a Trigger
Use this function to create a trigger.
Input Example
https://scf.tencentcloudapi.com/?Action=CreateTrigger
&FunctionName=<FunctionName>&TriggerName=<TriggerName>&Type=timer&TriggerDesc=*/2 * * * *
&<Common request parameters>Output Example
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.ApiGateway | Failed to create the API gateway trigger. |
| FailedOperation.Cos | Failed to operate on the COS resources. |
| FailedOperation.CreateTrigger | This operation is not supported in the current function state. |
| InternalError.ApiGateway | Internal errors occurred during the creation of the apigw trigger. |
| InternalError.Ckafka | ckafka API failure. |
| InternalError.Cmq | Failed to delete the cmq trigger. |
| InternalError.Cos | Failed to update the trigger. |
| InternalError.System | Internal system error. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.ApiGateway | ApiGateway parameter error. |
| InvalidParameterValue.Cdn | Cdn error. |
| InvalidParameterValue.Ckafka | Ckafka error. |
| InvalidParameterValue.Cos | Cos error. |
| InvalidParameterValue.CustomArgument | CustomArgument exceeds the length limit. |
| InvalidParameterValue.ServiceName | Invalid ServiceName. |
| InvalidParameterValue.TriggerDesc | TriggerDesc error. |
| InvalidParameterValue.TriggerName | TriggerName error. |
| InvalidParameterValue.Type | Type error. |
| InvalidParameterValue.ZipFile | Invalid ZipFile. |
| LimitExceeded.Cdn | The Cdn usage exceeds the upper limit. |
| LimitExceeded.FunctionOnTopic | The number of functions under the same topic exceeds the upper limit. |
| LimitExceeded.Trigger | The number of Triggers exceeds the upper limit. |
| ResourceInUse.Cdn | Cdn is in use. |
| ResourceInUse.Cmq | Cmq is in use. |
| ResourceInUse.Cos | Cos is in use. |
| ResourceInUse.Trigger | This TriggerName already exists. |
| ResourceInUse.TriggerName | This TriggerName already exists. |
| ResourceInsufficient.COS | Insufficient COS resources. |
| ResourceNotFound.Cdn | Cdn does not exist. |
| ResourceNotFound.Ckafka | Ckafka does not exist. |
| ResourceNotFound.Cmq | Cmq does not exist. |
| ResourceNotFound.Cos | Cos does not exist. |
| ResourceNotFound.Function | The function does not exist. |
| ResourceNotFound.FunctionName | The function does not exist. |
| ResourceNotFound.FunctionVersion | The function version does not exist. |
| ResourceNotFound.Version | The version does not exist. |
| UnauthorizedOperation.CAM | CAM authentication failed. |
| UnauthorizedOperation.CreateTrigger | You do not have permissions. |
| UnsupportedOperation.Cdn | Cdn is not supported. |
| UnsupportedOperation.Cos | Cos operation is not supported. |
| UnsupportedOperation.Trigger | Trigger operation is not supported. |
