tencent cloud

Feedback

ModifyFunctionTargets

Last updated: 2024-09-05 19:30:00

    1. API Description

    Domain name for API request: clb.tencentcloudapi.com.

    This API is used to modify the cloud functions associated with a load balancing forwarding rule.

    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: ModifyFunctionTargets.
    Version Yes String Common Params. The value used for this API: 2018-03-17.
    Region No String Common Params. This parameter is not required for this API.
    LoadBalancerId Yes String CLB instance ID
    ListenerId Yes String CLB listener ID
    FunctionTargets.N Yes Array of FunctionTarget The backend cloud functions to modify
    LocationId No String Forwarding rule ID. When binding a real server to a layer-7 forwarding rule, you must provide either this parameter or Domain+Url.
    Domain No String Target rule domain name. This parameter does not take effect if LocationId is specified.
    Url No String Target rule URL. This parameter does not take effect if LocationId is specified.

    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 the cloud functions associated with a forwarding rule

    Input Example

    POST / HTTP/1.1
    Host: clb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyFunctionTargets
    <Common request parameters>
    
    {
        "LocationId": "loc-xxxxxxxx",
        "ListenerId": "lbl-xxxxxxxx",
        "FunctionTargets": [
            {
                "Function": {
                    "FunctionNamespace": "ns_test",
                    "FunctionName": "name_test",
                    "FunctionQualifier": "version_test"
                },
                "Weight": "66"
            }
        ],
        "LoadBalancerId": "lb-xxxxxxxx"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "85c7b3e8-7fd8-4c62-8b3b-7ba52d7a1dca"
        }
    }
    

    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
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Length Wrong parameter length.
    ResourceNotFound Resources do not exist.
    UnauthorizedOperation Unauthorized operation.