接口请求域名： tat.intl.tencentcloudapi.com 。
此接口用于查询执行任务详情。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInvocationTasks。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InvocationTaskIds.N | 否 | Array of String | 执行任务ID列表，每次请求的上限为100。参数不支持同时指定 InvocationTaskIds 和 Filters。 |
| Filters.N | 否 | Array of Filter | 过滤条件。 - invocation-task-id - String - 是否必填：否 -（过滤条件）按照执行任务ID过滤。 - invocation-id - String - 是否必填：否 -（过滤条件）按照执行活动ID过滤。可通过 DescribeInvocations(查询执行活动) 接口获取。 - instance-id - String - 是否必填：否 -（过滤条件）按照实例ID过滤。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： CVM、Lighthouse、TAT 托管实例 - command-id - String - 是否必填：否 -（过滤条件）按照命令ID过滤。可通过 DescribeCommands(查询命令详情) 接口获取。 每次请求的 Filters 的上限为10， Filter.Values 的上限为5。参数不支持同时指定 InvocationTaskIds 和 Filters 。 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。关于 Limit 的更进一步介绍请参考 API 简介中的相关小节。 |
| Offset | 否 | Integer | 偏移量，默认为0。关于 Offset 的更进一步介绍请参考 API 简介中的相关小节。 |
| HideOutput | 否 | Boolean | 是否隐藏命令输出结果，取值范围： - true：隐藏输出 - false：不隐藏 默认为 true。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的执行任务总数。 |
| InvocationTaskSet | Array of InvocationTask | 执行任务列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInvocationTasks
<公共请求参数>
{
"Offset": 0,
"Limit": 10,
"HideOutput": false,
"Filters": [
{
"Name": "invocation-id",
"Values": [
"inv-1vll7hda"
]
}
]
}
{
"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"
}
]
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ConflictParameter | 参数冲突。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidCommandId | CommandId 无效。 |
| InvalidParameterValue.InvalidFilter | Filter 无效。 |
| InvalidParameterValue.InvalidInstanceId | 实例ID无效。 |
| InvalidParameterValue.InvalidInvocationId | 不合法的执行活动ID。 |
| InvalidParameterValue.InvalidInvocationTaskId | 不合法的执行任务ID。 |
| UnauthorizedOperation.CamAuthFailed | CAM鉴权失败。 |
| UnauthorizedOperation.InvalidToken | Token 无效。 |
| UnauthorizedOperation.MFAExpired | Multi-Factor Authentication(MFA) 过期。 |
| UnauthorizedOperation.MFANotFound | Multi-Factor Authentication(MFA) 不存在。 |
| UnsupportedOperation | 操作不支持。 |
文档反馈