当前位置：主页 > 查看内容

腾讯云自动化助手 查询执行任务 - API 文档

发布时间：2021-09-13 00:00| 有 位朋友查看

简介：1. 接口描述 接口请求域名： tat.tencentcloudapi.com 。 此接口用于查询执行任务详情。 默认接口请求频率限制：20次/秒。 推荐使用 API Explorer 点击调试 API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请……

1. 接口描述

接口请求域名： tat.tencentcloudapi.com 。

此接口用于查询执行任务详情。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
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-id - String - 是否必填：否 -（过滤条件）按照执行活动ID过滤。
  • invocation-task-id - String - 是否必填：否 -（过滤条件）按照执行任务ID过滤。
  • instance-id - String - 是否必填：否 -（过滤条件）按照实例ID过滤。
    每次请求的 Filters 的上限为10， Filter.Values 的上限为5。参数不支持同时指定 InvocationTaskIds 和 Filters 。
    		•
    Limit 否 Integer 返回数量，默认为20，最大值为100。关于 Limit 的更进一步介绍请参考 API 简介中的相关小节。
    Offset 否 Integer 偏移量，默认为0。关于 Offset 的更进一步介绍请参考 API 简介中的相关小节。
    HideOutput 否 Boolean 是否隐藏输出，取值范围：
  • True：隐藏输出
  • False：不隐藏
    默认为 True。
    		•

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的执行任务总数。
    InvocationTaskSet Array of InvocationTask 执行任务列表。
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 根据执行活动ID查询所有执行任务详情

    输入示例

    POST / HTTP/1.1
Host: tat.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": 3,
    "InvocationTaskSet": [
      {
        "CommandId": "cmd-13axrtuq",
        "CommandDocument": {
          "Content": "d2hvYW1p",
          "CommandType": "SHELL",
          "Timeout": 1,
          "WorkingDirectory": "/root/"
        },
        "InvocationId": "inv-1vll7hda",
        "InvocationTaskId": "invt-afwuqts2",
        "TaskStatus": "SUCCESS",
        "InstanceId": "ins-zj0f57ev",
        "TaskResult": {
          "ExitCode": 0,
          "Output": "cm9vdAo=",
          "ExecStartTime": "2020-11-05T07:49:58+00:00",
          "ExecEndTime": "2020-11-05T07:50:04+00:00"
        },
        "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"
      },
      {
        "CommandId": "cmd-13axrtuq",
        "CommandDocument": {
          "Content": "d2hvYW1p",
          "CommandType": "SHELL",
          "Timeout": 1,
          "WorkingDirectory": "/root/"
        },
        "InvocationId": "inv-1vll7hda",
        "InvocationTaskId": "invt-08oe5fe2",
        "TaskStatus": "SUCCESS",
        "InstanceId": "ins-zj0f57ex",
        "TaskResult": {
          "ExitCode": 0,
          "Output": "cm9vdAo=",
          "ExecStartTime": "2020-11-05T07:49:58+00:00",
          "ExecEndTime": "2020-11-05T07:50:04+00:00"
        },
        "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"
      },
      {
        "CommandId": "cmd-13axrtuq",
        "CommandDocument": {
          "Content": "d2hvYW1p",
          "CommandType": "SHELL",
          "Timeout": 1,
          "WorkingDirectory": "/root/"
        },
        "InvocationId": "inv-1vll7hda",
        "InvocationTaskId": "invt-91cpqs22",
        "TaskStatus": "SUCCESS",
        "InstanceId": "ins-zj0f57ew",
        "TaskResult": {
          "ExitCode": 0,
          "Output": "cm9vdAo=",
          "ExecStartTime": "2020-11-05T07:49:58+00:00",
          "ExecEndTime": "2020-11-05T07:50:04+00:00"
        },
        "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. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    • 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++
    • Tencent Cloud SDK 3.0 for Ruby

    命令行工具

    • Tencent Cloud CLI 3.0

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.ConflictParameter 参数冲突。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.InvalidFilter Filter 无效。

    本站部分内容转载于网络，版权归原作者所有，转载之目的在于传播更多优秀技术内容，如有侵权请联系QQ/微信：153890879删除，谢谢！
    上一篇：CreateAutoSnapshotPolicy - 云服务器 ECS 下一篇：没有了

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐