接口请求域名： tat.intl.tencentcloudapi.com 。
此接口用于创建执行器。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateInvoker。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Name | 是 | String | 执行器名称。长度不超过 120 字符。 |
| Type | 是 | String | 执行器类型。 可选取值（当前仅支持一种）： - SCHEDULE：周期类型执行器。 |
| CommandId | 是 | String | 远程命令ID。 可通过 DescribeCommands(查询命令详情) 接口获取。 |
| InstanceIds.N | 是 | Array of String | 触发器关联的实例ID。列表上限 100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 DescribeAutomationAgentStatus(查询客户端状态) 接口查询客户端状态。 |
| Username | 否 | String | 命令执行用户。长度不超过 256 字符。 |
| Parameters | 否 | String | 命令自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 |
| ScheduleSettings | 否 | ScheduleSettings | 周期执行器设置。 当执行器类型为 SCHEDULE 时，必须指定此参数。 |
| Tags.N | 否 | Array of Tag | 为命令关联的标签，列表长度不超过10 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InvokerId | String | 执行器ID。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
北京时间 2021-09-01 00:00:00 在实例 ins-yx05ky8j 执行命令 cmd-m7uma92n
POST / HTTP/1.1
Host: tat.intl.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"
}
}
在北京时间每月1日零点，在实例 ins-yx05ky8j 执行命令 cmd-m7uma92n
POST / HTTP/1.1
Host: tat.intl.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"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 鉴权错误 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.ID | ID 格式错误。 |
| InvalidParameterValue.InconsistentID | ID 数组中，ID 格式错误或格式不一致。 |
| InvalidParameterValue.InconsistentInstance | 实例类型不一致。 |
| InvalidParameterValue.InvalidCommandId | CommandId 无效。 |
| InvalidParameterValue.InvalidCronExpression | Crontab 表达式无效。 |
| InvalidParameterValue.InvalidInstanceId | 实例ID无效。 |
| InvalidParameterValue.InvalidTimeFormat | 无效的时间格式。 |
| InvalidParameterValue.InvokeTimeExpired | 调用时间已过期。 |
| InvalidParameterValue.ParameterInvalidJsonFormat | 参数为非法 json string 格式。 |
| InvalidParameterValue.Range | 参数取值范围不合法。 |
| InvalidParameterValue.TooLong | 长度超过限制。 |
| ResourceNotFound.CommandNotFound | 命令不存在。 |
| ResourceNotFound.InstanceNotFound | 实例不存在。 |
| ResourceUnavailable.AgentNotInstalled | Agent 未安装。 |
| ResourceUnavailable.AgentStatusNotOnline | Agent 不在线。 |
文档反馈