1. API Description
Domain name for API request: tat.tencentcloudapi.com.
This API is used to cancel the command executed on one or more CVM instances.
- If the command has not been delivered to the TAT agent, the task status is
PENDING,DELIVERING, orDELIVER_DELAYED, and will beCANCELLEDafter the command is canceled. - If the command has been delivered to the TAT agent, the task status is
RUNNING, and will beTERMINATEDafter the command is canceled.
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 | No | String | Common Params. This parameter is not required for this API. |
| InvocationId | Yes | String | Execution activity ID |
| InstanceIds.N | No | Array of String | Instance ID list. A maximum of 100 IDs are allowed. Supported instance types:CVMLIGHTHOUSE |
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 Canceling the execution of a command
Input Example
POST / HTTP/1.1
Host: tat.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.
- 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
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.InstanceIsNotRelatedToInvocation | The instance with this ID has no such execution activity. |
| 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. |
Yes
No
Was this page helpful?