接口请求域名： tat.intl.tencentcloudapi.com 。
此接口用于修改执行器。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyInvoker。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InvokerId | 是 | String | 待修改的执行器ID。 可通过 DescribeInvokers(查询执行器) 接口获取。 |
| Name | 否 | String | 待修改的执行器名称。长度不超过 120 字符。 |
| Type | 否 | String | 待修改的执行器类型。 可选取值（当前仅支持一种）： - SCHEDULE：周期类型执行器。 |
| CommandId | 否 | String | 待修改的命令ID。 可通过 DescribeCommands(查询命令详情) 接口获取。 |
| Username | 否 | String | 待修改的用户名。长度不超过 256 字符。 |
| Parameters | 否 | String | 待修改的自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 |
| InstanceIds.N | 否 | Array of String | 待修改的实例ID列表。列表长度上限100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 DescribeAutomationAgentStatus(查询客户端状态) 接口查询客户端状态。 |
| ScheduleSettings | 否 | ScheduleSettings | 待修改的周期执行器设置。 要将执行器类型修改为 SCHEDULE 时，必须指定此参数。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInvoker
<公共请求参数>
{
"InvokerId": "ivk-b7s3qa5l",
"Parameters": "{\"var\": \"1\"}"
}
{
"Response": {
"RequestId": "7f3acde8-196d-4be4-9fa7-359f79b026bc"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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 未安装。 |
文档反馈