ModifyInvoker

Last updated:2026-03-05 16:27:07

ModifyInvoker

Last updated: 2026-03-05 16:27:07

1. API Description

Domain name for API request: tat.intl.tencentcloudapi.com.

This API is used to modify an invoker.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyInvoker.
Version	Yes	String	Common Params. The value used for this API: 2020-10-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InvokerId	Yes	String	Executor ID to be modified. Call the DescribeInvokers api to query execution.
Name	No	String	Executor name to be modified. length not exceeding 120 characters.
Type	No	String	Executor type to be modified. Selectable values (currently only support one):. -`SCHEDULE`: period type executor.
CommandId	No	String	Command ID to be modified. Call the DescribeCommands api to query command details.
Username	No	String	Username to be modified. length not exceeding 256 characters.
Parameters	No	String	Custom parameters to be modified. field type is JSON encode string. This parameter can be set only when EnableParameter of the command specified by CommandId is true. obtain the EnableParameter settings through the DescribeCommands (query command details) api.
InstanceIds.N	No	Array of String	List of instance ids to be modified. list length limit 100. You can get the instance ID through the query instance interface of corresponding cloud services. currently supports instance types: CVM, Lighthouse, and TAT managed instances. The instance needs to have the TAT client installed, and the client must be in Online status. you can query client status via the DescribeAutomationAgentStatus api.
ScheduleSettings	No	ScheduleSettings	Recurring invoker settings to be modified. Change the executor type to `SCHEDULE` and specify this parameter.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying an invoker

Input Example

POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInvoker
<Common request parameters>

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

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
AuthFailure	CAM signature/authentication error.
InternalError	Internal error.
InvalidParameterValue.ID	Invalid ID format.
InvalidParameterValue.InconsistentID	Invalid ID format or inconsistent format in the array.
InvalidParameterValue.InconsistentInstance	Inconsistent instance type.
InvalidParameterValue.InvalidCronExpression	Invalid crontab expression.
InvalidParameterValue.InvalidInstanceId	Invalid instance ID.
InvalidParameterValue.InvalidInvokerId	Invalid InvokerId.
InvalidParameterValue.InvalidTimeFormat	Invalid time format.
InvalidParameterValue.InvokeTimeExpired	API invocation expired.
InvalidParameterValue.LimitExceeded	Parameter limit exceeded.
InvalidParameterValue.ParameterDisabled	The custom parameter feature is not enabled.
InvalidParameterValue.ParameterInvalidJsonFormat	The parameter is not a valid JSON string.
InvalidParameterValue.Range	The parameter value is not in the valid range.
InvalidParameterValue.TooLong	Length limit exceeded.
ResourceNotFound.CommandNotFound	The command does not exist.
ResourceNotFound.InstanceNotFound	The instance does not exist.
ResourceUnavailable.AgentNotInstalled	TAT Agent is not installed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud