自动化助手
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 自动化助手 > API 文档 > 远程命令相关接口 > 查询执行器

查询执行器

最近更新时间：2024-03-12 01:48:51

我的收藏

本页目录：

1. 接口描述

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

此接口用于查询执行器信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeInvokers。
Version 是 String 公共参数，本接口取值：2020-10-28。
Region 是 String 公共参数，详见产品支持的 地域列表。
InvokerIds.N 否 Array of String 执行器ID列表。
示例值：["ivk-b7s3qa5l"]
Filters.N 否 Array of Filter 过滤条件：

  • invoker-id - String - 是否必填：否 - （过滤条件）按执行器ID过滤。
  • command-id - String - 是否必填：否 - （过滤条件）按命令ID过滤。
  • type - String - 是否必填：否 - （过滤条件）按执行器类型过滤。
    		•
    Limit 否 Integer 返回数量，默认为20，最大值为100。
    示例值：10
    Offset 否 Integer 偏移量，默认为0。
    示例值：0

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 满足条件的执行器数量。
    示例值：10
    InvokerSet Array of Invoker 执行器信息。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询执行器

    输入示例

    POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInvokers
<公共请求参数>

{
    "Filters": [
        {
            "Name": "invoker-id",
            "Values": [
                "ivk-b7s3qa5l"
            ]
        }
    ]
}

    输出示例

    {
    "Response": {
        "RequestId": "a4c828cf-31c9-42d2-a558-2ad340a76ef0",
        "TotalCount": 1,
        "InvokerSet": [
            {
                "InvokerId": "ivk-b7s3qa5l",
                "Name": "test-invoker",
                "Type": "SCHEDULE",
                "CommandId": "cmd-m7uma92n",
                "Username": "root",
                "Parameters": "{\"var\": \"1\"}",
                "InstanceIds": [
                    "ins-yx05ky8j"
                ],
                "Enable": false,
                "ScheduleSettings": {
                    "Policy": "ONCE",
                    "Recurrence": "",
                    "InvokeTime": ""
                },
                "CreatedTime": "2021-08-30T06:42:02Z",
                "UpdatedTime": "2021-09-09T12:07:00Z"
            }
        ]
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    AuthFailure CAM签名/鉴权错误。
    InvalidParameter.ConflictParameter 参数冲突。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.InvalidFilter Filter 无效。
    InvalidParameterValue.InvalidInvokerId InvokerId 无效。
    中国站