tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyInvoker

Last updated: 2024-11-27 10:36:25

    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 ID of the invoker to be modified.
    Name No String Name of the invoker to be modified.
    Type No String Invoker type. It can only be SCHEDULE (recurring invokers).
    CommandId No String ID of the command to be modified.
    Username No String The username to be modified.
    Parameters No String Custom parameters to be modified.
    InstanceIds.N No Array of String List of instance IDs to be modified. Up to 100 IDs are allowed.
    ScheduleSettings No ScheduleSettings Scheduled invoker settings to be modified.

    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

    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.InconsistentInstance Inconsistent instance type.
    InvalidParameterValue.InvalidInstanceId Invalid instance ID.
    InvalidParameterValue.InvalidInvokerId Invalid InvokerId.
    InvalidParameterValue.ParameterDisabled The custom parameter feature is not enabled.
    InvalidParameterValue.ParameterInvalidJsonFormat The parameter is not a valid JSON string.
    ResourceNotFound.CommandNotFound The command does not exist.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    ResourceUnavailable.AgentNotInstalled TAT Agent is not installed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy