tencent cloud



Last updated: 2023-07-18 11:11:06

1. API Description

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

This API is used to terminate a running async function event.

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: TerminateAsyncEvent.
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
InvokeRequestId Yes String Terminated invocation request ID
Namespace No String Namespace
GraceShutdown No Boolean Whether to enable grace shutdown. If it’s true, a SIGTERM signal is sent to the specified request. See [Sending termination signal](https://www.tencentcloud.com/document/product/583/63969?from_cn_redirect=1#.E5.8F.91.E9.80.81.E7.BB.88.E6.AD.A2.E4.BF.A1.E5.8F.B7]. It’s set to false by default.

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 Terminating async event

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "RequestId": "ee33a89b-3825-4d2f-bd88-35a8fa27aae1"

5. Developer Resources


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.AsyncEventStatus This operation is not supported by the current async event status. Please try again later.
InvalidParameterValue.FunctionName The function does not exist.
ResourceNotFound.AsyncEvent The specified AsyncEvent was not found. Please create it and try again.
ResourceNotFound.Function The function does not exist.
ResourceNotFound.Namespace Namespace does not exist.
Contact Us

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

Technical Support

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

7x24 Phone Support