tencent cloud

文档反馈

DeleteTrigger

最后更新时间:2023-05-05 10:16:39

1. API Description

Domain name for API request: scf.tencentcloudapi.com.

This API is used to delete an existing trigger based on the input parameters.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: DeleteTrigger.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region No String Common Params. This parameter is not required for this API.
FunctionName Yes String Function name
TriggerName Yes String Name of the trigger to be deleted
Type Yes String Type of the trigger to be deleted. Currently, COS, CMQ, timer, and ckafka triggers are supported.
Namespace No String Function namespace
TriggerDesc No String This field is required if a COS trigger is to be deleted. It stores the data {"event":"cos:ObjectCreated:*"} in the JSON format. The data content of this field is in the same format as that of SetTrigger. This field is optional if a scheduled trigger or CMQ trigger is to be deleted.
Qualifier No String Function version. It defaults to $LATEST. It’s recommended to use [$DEFAULT](https://www.tencentcloud.com/document/product/583/36149?from_cn_redirect=1#.E9.BB.98.E8.AE.A4.E5.88.AB.E5.90.8D) for canary release.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting a trigger

This example shows you how to delete a trigger.

Input Example

POST / HTTP/1.1
Host: scf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteTrigger
<Common request parameters>

{
    "Type": "timer",
    "FunctionName": "ledDummyAPITest",
    "TriggerName": "test3"
}

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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 Operation failed.
FailedOperation.CreateTrigger This operation is not supported in the current function state.
FailedOperation.DeleteTrigger Failed to delete the trigger.
InternalError Internal error.
InternalError.System Internal system error.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.ApiGateway ApiGateway parameter error.
InvalidParameterValue.Cdn Cdn error.
InvalidParameterValue.Cmq Cmq error.
InvalidParameterValue.Cos Cos error.
InvalidParameterValue.FunctionName The function does not exist.
InvalidParameterValue.TriggerDesc TriggerDesc error.
InvalidParameterValue.TriggerName TriggerName error.
InvalidParameterValue.Type Type error.
ResourceInUse.Cdn Cdn is in use.
ResourceInUse.Cmq Cmq is in use.
ResourceNotFound The resource does not exist.
ResourceNotFound.Cdn Cdn does not exist.
ResourceNotFound.Cmq Cmq does not exist.
ResourceNotFound.Function The function does not exist.
ResourceNotFound.FunctionName The function does not exist.
ResourceNotFound.Timer Timer does not exist.
ResourceNotFound.Trigger The trigger does not exist.
ResourceNotFound.Version The version does not exist.
UnauthorizedOperation.CAM CAM authentication failed.
UnauthorizedOperation.DeleteTrigger You do not have permissions.
UnsupportedOperation.Cdn Cdn is not supported.