有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

此接口用于创建执行器。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateInvoker。
Version String 公共参数,本接口取值:2020-10-28。
Region String 公共参数,详见产品支持的 地域列表
Name String 执行器名称。
示例值:invoker-test
Type String 执行器类型,当前仅支持周期类型执行器,取值:SCHEDULE
示例值:SCHEDULE
CommandId String 远程命令ID。
示例值:cmd-k4ypdij0
InstanceIds.N Array of String 触发器关联的实例ID。列表上限 100。
示例值:["ins-yx05ky8j"]
Username String 命令执行用户。
示例值:root
Parameters String 命令自定义参数。
示例值:{"var": "A"}
ScheduleSettings ScheduleSettings 周期执行器设置,当创建周期执行器时,必须指定此参数。

3. 输出参数

参数名称 类型 描述
InvokerId String 执行器ID。
示例值:ivk-b7s3qa5l
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建单次执行器

北京时间 2021-09-01 00:00:00 在实例 ins-yx05ky8j 执行命令 cmd-m7uma92n

输入示例

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

{
    "Name": "test-invoker",
    "CommandId": "cmd-m7uma92n",
    "InstanceIds": [
        "ins-yx05ky8j"
    ],
    "Type": "SCHEDULE",
    "ScheduleSettings": {
        "Policy": "ONCE",
        "InvokeTime": "2021-09-01T00:00:00+08:00"
    }
}

输出示例

{
    "Response": {
        "RequestId": "97268137-e0f7-477d-833b-766273d0ea47",
        "InvokerId": "ivk-le1g3x2h"
    }
}

示例2 创建周期执行命令

在北京时间每月1日零点,在实例 ins-yx05ky8j 执行命令 cmd-m7uma92n

输入示例

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

{
    "Name": "cron-invoker",
    "CommandId": "cmd-m7uma92n",
    "InstanceIds": [
        "ins-yx05ky8j"
    ],
    "Type": "SCHEDULE",
    "ScheduleSettings": {
        "Policy": "RECURRENCE",
        "Recurrence": "0 0 1 * *"
    }
}

输出示例

{
    "Response": {
        "RequestId": "d1d7ce29-b6ac-436d-93e0-b454f096cc50",
        "InvokerId": "ivk-n0t6rxtv"
    }
}

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签名/鉴权错误。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.InvalidCommandId CommandId 无效。
InvalidParameterValue.InvalidCronExpression Crontab 表达式无效。
InvalidParameterValue.InvalidInstanceId 实例ID无效。
InvalidParameterValue.InvalidTimeFormat 无效的时间格式。
InvalidParameterValue.InvokeTimeExpired 调用时间已过期。
InvalidParameterValue.ParameterInvalidJsonFormat 参数为非法 json string 格式。
ResourceNotFound.CommandNotFound 命令不存在。
ResourceNotFound.InstanceNotFound 实例不存在。
ResourceUnavailable.AgentNotInstalled Agent 未安装。
ResourceUnavailable.AgentStatusNotOnline Agent 不在线。