CancelInvocation

Last updated:2026-03-05 16:27:17

CancelInvocation

Last updated: 2026-03-05 16:27:17

1. API Description

Domain name for API request: tat.intl.tencentcloudapi.com.

Cancel the executed command on one or multiple instances.

If the command is not delivered to the agent and the task status is in PENDING, DELIVERING, or DELIVER_DELAYED, the state of a task is CANCELLED after cancellation.
If the command is sent to the agent and the task status is RUNNING, the task status is TERMINATED after cancellation.

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: CancelInvocation.
Version	Yes	String	Common Params. The value used for this API: 2020-10-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InvocationId	Yes	String	Execution activity ID. Call the DescribeInvocations api to query execution.
InstanceIds.N	No	Array of String	Instance ID list. upper limit: 100. Instance ID can be obtained through the query instance interface of corresponding cloud services. currently supported instance types:. - CVM - Lighthouse - TAT Register instance.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Canceling the execution of a command

Input Example

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

{
    "InvocationId": "inv-ib2lld37",
    "InstanceIds": [
        "ins-zcewfho0"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "b27421da-0ad4-4e11-b694-cda143606701"
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
InvalidParameterValue.InstanceIsNotRelatedToInvocation	The instance with this ID has no such execution activity.
InvalidParameterValue.InvalidInstanceId	Invalid instance ID.
InvalidParameterValue.InvalidInvocationId	Invalid execution activity ID.
InvalidParameterValue.LimitExceeded	Parameter limit exceeded.
InvalidParameterValue.TooLong	Length limit exceeded.
LimitExceeded	Reached the quota limit.
MissingParameter	Missing parameter.
ResourceNotFound.InvocationNotFound	No execution activity found.
UnauthorizedOperation.CamAuthFailed	CAM authentication failed.
UnauthorizedOperation.InvalidToken	Invalid token.
UnauthorizedOperation.MFAExpired	The Multi-factor authentication (MFA) code expired.
UnauthorizedOperation.MFANotFound	Multi-factor authentication (MFA) does not exist.
UnknownParameter	Unknown parameter error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud