自动化助手修改执行器

1. 接口描述

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

此接口用于修改执行器。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyInvoker。
Version	是	String	公共参数，本接口取值：2020-10-28。
Region	是	String	公共参数，详见产品支持的地域列表。
InvokerId	是	String	待修改的执行器ID。可通过 DescribeInvokers(查询执行器) 接口获取。示例值：ivk-n0t6rxtv
Name	否	String	待修改的执行器名称。长度不超过 120 字符。示例值：invoker-test
Type	否	String	待修改的执行器类型。可选取值（当前仅支持一种）： - `SCHEDULE`：周期类型执行器。示例值：SCHEDULE
CommandId	否	String	待修改的命令ID。可通过 DescribeCommands(查询命令详情) 接口获取。示例值：cmd-m7uma92n
Username	否	String	待修改的用户名。长度不超过 256 字符。示例值：root
Parameters	否	String	待修改的自定义参数。字段类型为 JSON encode string。仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。示例值：{"var": "A"}
InstanceIds.N	否	Array of String	待修改的实例ID列表。列表长度上限100。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 DescribeAutomationAgentStatus(查询客户端状态) 接口查询客户端状态。示例值：["ins-yx05ky8j"]
ScheduleSettings	否	ScheduleSettings	待修改的周期执行器设置。要将执行器类型修改为 `SCHEDULE` 时，必须指定此参数。示例值：{ "Policy":"ONCE", "InvokeTime":"2021-09-01T00:00:00+08:00" }

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改执行器

输入示例

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

{
    "InvokerId": "ivk-b7s3qa5l",
    "Parameters": "{\"var\": \"1\"}"
}

输出示例

{
    "Response": {
        "RequestId": "7f3acde8-196d-4be4-9fa7-359f79b026bc"
    }
}

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: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
InternalError	内部错误。
InvalidParameterValue.ID	ID 格式错误。
InvalidParameterValue.InconsistentID	ID 数组中，ID 格式错误或格式不一致。
InvalidParameterValue.InconsistentInstance	实例类型不一致。
InvalidParameterValue.InvalidCronExpression	Crontab 表达式无效。
InvalidParameterValue.InvalidInstanceId	实例ID无效。
InvalidParameterValue.InvalidInvokerId	InvokerId 无效。
InvalidParameterValue.InvalidTimeFormat	无效的时间格式。
InvalidParameterValue.InvokeTimeExpired	调用时间已过期。
InvalidParameterValue.LimitExceeded	超过参数限制。
InvalidParameterValue.ParameterDisabled	未启用自定义参数功能。
InvalidParameterValue.ParameterInvalidJsonFormat	参数为非法 json string 格式。
InvalidParameterValue.Range	参数取值范围不合法。
InvalidParameterValue.TooLong	长度超过限制。
ResourceNotFound.CommandNotFound	命令不存在。
ResourceNotFound.InstanceNotFound	实例不存在。
ResourceUnavailable.AgentNotInstalled	Agent 未安装。

修改执行器

本页目录：