DescribeInvocationTasks

Download PDF

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

DescribeInvocationTasks

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

Download PDF

1. API Description

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

This API is used to query execution task details.

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: DescribeInvocationTasks.
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.
InvocationTaskIds.N	No	Array of String	List of execution task IDs. Up to 100 IDs are allowed for each request. `InvocationTaskIds` and `Filters` cannot be specified at the same time.
Filters.N	No	Array of Filter	Filter conditions. . -invocation-task-id - String - required: no - (filter condition) filter by executing task id. - invocation-id - String - required: no - (filter condition) filter by the execution activity id. you can obtain it through the DescribeInvocations api. -instance-id - String - required: no - (filtering conditions) filter by instance id. you can get the instance id through the query instance interface of corresponding cloud services. currently supported instance types: CVM, Lighthouse, and managed instances of TAT. -command-id - String - required: no - (filter criteria) filter by command id. obtain through the api DescribeCommands (query command details). The maximum number of `Filters` per request is 10, and that of `Filter.Values` is 5. the `InvocationTaskIds` and `Filters` parameters cannot be specified at the same time.
Limit	No	Integer	Number of returned results. It defaults to `20`. The maximum is 100. For more information on `Limit`, see the relevant section in the API Overview.
Offset	No	Integer	Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API Introduction.
HideOutput	No	Boolean	Whether to hide the command output result. valid values:. -true: hide output. - false: do not hide. The default value is true.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of matching execution tasks.
InvocationTaskSet	Array of InvocationTask	List of execution tasks.
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 Query All Task Execution Details Based on Execution Activity ID

Input Example

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

{
    "Offset": 0,
    "Limit": 10,
    "HideOutput": false,
    "Filters": [
        {
            "Name": "invocation-id",
            "Values": [
                "inv-1vll7hda"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "a1df9725-51c6-466d-a038-4c86461a8e26",
        "TotalCount": 1,
        "InvocationTaskSet": [
            {
                "CommandId": "cmd-13axrtuq",
                "CommandDocument": {
                    "Content": "d2hvYW1p",
                    "CommandType": "SHELL",
                    "Timeout": 1,
                    "Username": "root",
                    "WorkingDirectory": "/root/",
                    "OutputCOSBucketUrl": "https://example-123456789.cos.ap-beijing.myqcloud.com",
                    "OutputCOSKeyPrefix": "datalog"
                },
                "InvocationId": "inv-1vll7hda",
                "InvocationTaskId": "invt-08oe5fe2",
                "TaskStatus": "SUCCESS",
                "InstanceId": "ins-zj0f57ex",
                "TaskResult": {
                    "ExitCode": 0,
                    "Output": "cm9vdAo=",
                    "Dropped": 0,
                    "OutputUploadCOSErrorInfo": "",
                    "OutputUrl": "",
                    "ExecStartTime": "2020-11-05T07:49:58+00:00",
                    "ExecEndTime": "2020-11-05T07:50:04+00:00"
                },
                "ErrorInfo": "",
                "InvocationSource": "user",
                "StartTime": "2020-11-05T07:49:58+00:00",
                "EndTime": "2020-11-05T07:50:04+00:00",
                "CreatedTime": "2020-11-05T07:49:56+00:00",
                "UpdatedTime": "2020-11-05T07:50:06+00:00"
            }
        ]
    }
}

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.
InvalidParameter.ConflictParameter	Conflicting parameters.
InvalidParameterValue	Invalid parameter value.
InvalidParameterValue.InvalidCommandId	Invalid CommandId.
InvalidParameterValue.InvalidFilter	Invalid filter.
InvalidParameterValue.InvalidInstanceId	Invalid instance ID.
InvalidParameterValue.InvalidInvocationId	Invalid execution activity ID.
InvalidParameterValue.InvalidInvocationTaskId	Invalid execution task ID.
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.
UnsupportedOperation	The operation is not supported.

Was this page helpful?

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

Yes

Feedback

tencent cloud