有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

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

此接口用于查询执行活动详情。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInvocations。
Version String 公共参数,本接口取值:2020-10-28。
Region String 公共参数,详见产品支持的 地域列表
InvocationIds.N Array of String 执行活动ID列表,每次请求的上限为100。参数不支持同时指定 InvocationIdsFilters
示例值:["inv-xxxxxxxx"]
Filters.N Array of Filter 过滤条件。


  • invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。

  • command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。

  • command-created-by - String - 是否必填:否 -(过滤条件)按照执行的命令类型过滤,取值为 TAT 或 USER,TAT 代表公共命令,USER 代表由用户创建的命令。

  • instance-kind - String - 是否必填:否 -(过滤条件)按照运行实例类型过滤,取值为 CVM 或 LIGHTHOUSE,CVM 代表实例为云服务器, LIGHTHOUSE 代表实例为轻量应用服务器。


  • 每次请求的 Filters 的上限为10, Filter.Values 的上限为5。参数不支持同时指定 InvocationIdsFilters
    Limit Integer 返回数量,默认为20,最大值为100。关于 Limit 的更进一步介绍请参考 API 简介中的相关小节。
    示例值:10
    Offset Integer 偏移量,默认为0。关于 Offset 的更进一步介绍请参考 API 简介中的相关小节。
    示例值:0

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的执行活动总数。
    示例值:1
    InvocationSet Array of Invocation 执行活动列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询执行活动

    输入示例

    POST / HTTP/1.1
    Host: tat.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeInvocations
    <公共请求参数>
    
    {
        "Offset": 0,
        "Limit": 1,
        "InvocationIds": [
            "inv-q4zp60g0"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "958a3603-d0c3-4c97-a37d-6bc24eacddac",
            "TotalCount": 1,
            "InvocationSet": [
                {
                    "CommandId": "cmd-9dxzty3m",
                    "CommandContent": "cHdk",
                    "CommandType": "SHELL",
                    "Timeout": 60,
                    "InvocationSource": "USER",
                    "WorkingDirectory": "/root",
                    "InvocationId": "inv-q4zp60g0",
                    "InstanceKind": "CVM",
                    "InvocationStatus": "SUCCESS",
                    "Description": "Test Invocation",
                    "Parameters": "",
                    "DefaultParameters": "",
                    "Username": "root",
                    "OutputCOSKeyPrefix": "cosprefix",
                    "OutputCOSBucketUrl": "https://example-123456789.cos.ap-beijing.myqcloud.com",
                    "InvocationTaskBasicInfoSet": [
                        {
                            "InvocationTaskId": "invt-kakne8h2",
                            "TaskStatus": "SUCCESS",
                            "InstanceId": "ins-zj0f57ew"
                        },
                        {
                            "InvocationTaskId": "invt-jc2onrxm",
                            "TaskStatus": "SUCCESS",
                            "InstanceId": "ins-zj0f57ex"
                        },
                        {
                            "InvocationTaskId": "invt-6xmuisyq",
                            "TaskStatus": "SUCCESS",
                            "InstanceId": "ins-zj0f57ev"
                        }
                    ],
                    "StartTime": "2020-11-09T07:21:59+00:00",
                    "EndTime": "2020-11-09T07:22:08+00:00",
                    "CreatedTime": "2020-11-09T07:21:59+00:00",
                    "UpdatedTime": "2020-11-09T07:22:08+00:00"
                }
            ]
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.ConflictParameter 参数冲突。
    InvalidParameterValue.InvalidCommandId CommandId 无效。
    InvalidParameterValue.InvalidFilter Filter 无效。
    InvalidParameterValue.InvalidInvocationId 不合法的执行活动ID。
    InvalidParameterValue.LimitExceeded 超过参数限制。
    LimitExceeded.FilterValueExceeded 填写的 Filter 取值过多。
    UnauthorizedOperation.CamAuthFailed CAM鉴权失败。
    UnauthorizedOperation.InvalidToken Token 无效。
    UnauthorizedOperation.MFAExpired Multi-Factor Authentication(MFA) 过期。
    UnauthorizedOperation.MFANotFound Multi-Factor Authentication(MFA) 不存在。