tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Serverless Cloud Function
    Documentation
    Download PDF

    UpdateTriggerStatus

    Last updated: 2023-07-18 11:10:58
    Download PDF

    1. API Description

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

    This API is used to update the trigger status.

    A maximum of 20 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: UpdateTriggerStatus.
    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.
    Enable Yes String Initial status of the trigger. Values: OPEN (enabled); CLOSE disabled)
    FunctionName Yes String Function name.
    TriggerName Yes String Trigger name
    Type Yes String Trigger Type
    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.
    Namespace No String Function namespace
    TriggerDesc No String To update a COS trigger, this field is required. 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.

    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 Modifying trigger status

    Input Example

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

{
    "Enable": "CLOSE",
    "Type": "timer",
    "FunctionName": "<FunctionName>",
    "TriggerName": "<TriggerName>"
}

    Output Example

    {
    "Response": {
        "RequestId": "375d4028-2666-4cef-bcab-2331cb974fc3"
    }
}

    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.Cos Failed to operate on the COS resources.
    FailedOperation.CreateTrigger This operation is not supported in the current function state.
    FailedOperation.UpdateStatus Failed to update the status
    FailedOperation.UpdateTriggerStatus The new status is the same as the previous one.
    InternalError.Cmq Failed to delete the cmq trigger.
    InternalError.Cos Failed to update the trigger.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.CosNotifyRuleConflict COS notification rule conflict
    InvalidParameterValue.Enable The value of Enable does not conform to the specification. Please fix it and try again. For more information, please visit https://tencentcs.com/5jXKFnBW.
    InvalidParameterValue.TriggerDesc TriggerDesc error.
    InvalidParameterValue.TriggerName TriggerName error.
    InvalidParameterValue.Type Type error.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.Function The function does not exist.
    ResourceNotFound.FunctionName The function does not exist.
    ResourceNotFound.Namespace Namespace does not exist.
    ResourceNotFound.Qualifier The version does not exist.
    ResourceNotFound.Trigger The trigger does not exist.
    UnauthorizedOperation.CAM CAM authentication failed.
    UnauthorizedOperation.UpdateTriggerStatus You are not authorized for the operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy