tencent cloud

Feedback

DeregisterFunctionTargets

Last updated: 2023-10-30 11:34:49

    1. API Description

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

    This API is used to unbind a SCF function with a CLB forwarding rule. For L7 listeners, you need to specify the forwarding rule by using LocationId or Domain+Url.
    This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID to check whether this task is successful.

    Limits:

    • Binding with SCF is only available in Guangzhou, Shenzhen Finance, Shanghai, Shanghai Finance, Beijing, Chengdu, Hong Kong (China), Singapore, Mumbai, Tokyo, and Silicon Valley.
    • SCF functions can only be bound with CLB instances of bill-by-IP accounts but not with bill-by-CVM accounts. If you are using a bill-by-CVM account, we recommend upgrading it to a bill-by-IP account.
    • SCF functions cannot be bound with classic CLB instances.
    • SCF functions cannot be bound with classic network-based CLB instances.
    • SCF functions in the same region can be bound with CLB instances. SCF functions can only be bound across VPCs but not regions.
    • SCF functions can only be bound with IPv4 and IPv6 NAT64 CLB instances, but currently not with IPv6 CLB instances.
    • SCF functions can only be bound with layer-7 HTTP and HTTPS listeners, but not with layer-7 QUIC listeners or layer-4 (TCP, UDP, and TCP SSL) listeners.
    • Only SCF event-triggered functions can be bound with CLB instances.

    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: DeregisterFunctionTargets.
    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 List of functions to be unbound
    LocationId No String The ID of target forwarding rule. To unbind a function from an L7 forwarding rule, either LocationId or Domain+Url is required.
    Domain No String Domain name of the target forwarding rule. It is ignored if LocationId is specified.
    Url No String URL of the target forwarding rule. It is ignored if LocationId is specified.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Unbinding an SCF function from a forwarding rule

    This example shows you how to unbind a function from a load balancer forwarding rule.

    Input Example

    https://clb.tencentcloudapi.com/?Action=DeregisterFunctionTargets
    &LoadBalancerId=lb-cuxw2rm0
    &ListenerId=lbl-d1ubsydq
    &LocationId=loc-abcd1234
    &FunctionTargets.0.Weight=66
    &FunctionTargets.0.Function.FunctionNamespace=ns_test
    &FunctionTargets.0.Function.FunctionName=name_test
    &FunctionTargets.0.Function.FunctionQualifier=version_test
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "11b4338f-2d00-4766-bc67-581d959b3488"
        }
    }
    

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

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support