tencent cloud

APIs

DocumentaçãoAPIsCloud Load BalancerBackend Service APIsRegisterFunctionTargets

RegisterFunctionTargets

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-06-17 17:27:15

1. API Description

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

This API is used to bind a cloud function to the forwarding rule of a Cloud Load Balancer. Before that, you need to create a related HTTP or HTTPS listener and forwarding rule.
This API is used to perform asynchronous operations. After returning a successful result, call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.
This API is used to describe restrictions.

  • SCF binding is supported only in Guangzhou, Shenzhen Finance, Shanghai, Shanghai Finance, Beijing, Chengdu, Hong Kong (China), Singapore, Tokyo, and Silicon Valley.
  • Only the standard account type supports binding SCF. The classic account type is unsupported. We recommend upgrading to the standard account type. For more information, see Checking Account Type.
  • Classic CLB does not support binding SCF.
  • Basic Network Type does not support binding SCF.
  • CLB supports binding ALL SCFs in the same region by default, supports cross-VPC binding, but cross-region selection is not supported.
  • Currently, only IPv4 and IPv6 NAT64 versions of Cloud Load Balancer support binding SCF. IPv6 version is not currently supported.
  • Only layer-7 (HTTP, HTTPS) listeners support binding SCF. Layer-4 (TCP, UDP, TCP SSL) listeners and layer-7 QUIC listeners are unsupported.
  • CLB binding SCF only supports binding SCF of the "Event function" type.
  • A forwarding rule supports binding only one SCF.

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: RegisterFunctionTargets.
Version Yes String Common Params. The value used for this API: 2018-03-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String CLB instance ID.
ListenerId Yes String CLB listener ID.
FunctionTargets.N Yes Array of FunctionTarget SCF functions to be bound.
LocationId No String ID of the target forwarding rule. To bind an SCF function to a L7 forwarding rule, this parameter 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, 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 Binding a Cloud Function to a Forwarding Rule

This example shows you how to bind a cloud function to the layer-7 forwarding rule of a load balancing instance.

Input Example

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

{
    "LocationId": "loc-abcd1234",
    "ListenerId": "lbl-d1ub****",
    "FunctionTargets": [
        {
            "Function": {
                "FunctionNamespace": "ns_test",
                "FunctionName": "name_test",
                "FunctionQualifier": "version_test"
            },
            "Weight": 66
        }
    ],
    "LoadBalancerId": "lb-cuxw****"
}

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.
FailedOperation.ResourceInOperating The specified resource is currently being operated. Please try again later.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameter.LBIdNotFound CLB instance ID error.
InvalidParameter.ListenerIdNotFound Listener ID error.
InvalidParameter.LocationNotFound Unable to find eligible forwarding rules.
InvalidParameter.ProtocolCheckFailed Listener protocol check failed because, for example, the protocol used is incompatible with the corresponding operation.
InvalidParameterValue Parameter value error.
InvalidParameterValue.Duplicate Duplicate parameter values.
InvalidParameterValue.Length Invalid parameter length.
LimitExceeded The quota limit is exceeded.
MissingParameter Parameters are missing.
ResourceNotFound Resources do not exist.
UnauthorizedOperation Unauthorized operation.
Anterior: ModifyFunctionTargetsPróximo: DescribeTargets

Ajuda e Suporte

Esta página foi útil?

comentários