有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: clb.tencentcloudapi.com 。

RegisterFunctionTargets 接口用来将一个云函数绑定到负载均衡的7层转发规则,在此之前您需要先行创建相关的7层监听器(HTTP、HTTPS)和转发规则。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。

限制说明:

  • 仅广州、深圳金融、上海、上海金融、北京、成都、中国香港、新加坡、孟买、东京、硅谷地域支持绑定 SCF。
  • 仅标准账户类型支持绑定 SCF,传统账户类型不支持。建议升级为标准账户类型,详情可参见 账户类型升级说明
  • 传统型负载均衡不支持绑定 SCF。
  • 基础网络类型不支持绑定 SCF。
  • CLB 默认支持绑定同地域下的所有 SCF,可支持跨 VPC 绑定 SCF,不支持跨地域绑定。
  • 目前仅 IPv4、IPv6 NAT64 版本的负载均衡支持绑定 SCF,IPv6 版本的暂不支持。
  • 仅七层(HTTP、HTTPS)监听器支持绑定 SCF,四层(TCP、UDP、TCP SSL)监听器和七层 QUIC 监听器不支持。
  • CLB 绑定 SCF 仅支持绑定“Event 函数”类型的云函数。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RegisterFunctionTargets。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡实例 ID。
示例值:lb-1234abcd
ListenerId String 负载均衡监听器 ID。
示例值:lis-1234tgbh
FunctionTargets.N Array of FunctionTarget 待绑定的云函数列表。
LocationId String 目标转发规则的 ID,当将云函数绑定到七层转发规则时,必须输入此参数或 Domain+Url 参数。
示例值:loc-1234rrrr
Domain String 目标转发规则的域名,若已经输入 LocationId 参数,则本参数不生效。
示例值:www.123.com
Url String 目标转发规则的 URL,若已经输入 LocationId 参数,则本参数不生效。
示例值:/test

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 绑定云函数到转发规则上

将一个云函数绑定到负载均衡实例的7层转发规则上。

输入示例

POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RegisterFunctionTargets
<公共请求参数>

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameter.LBIdNotFound 负载均衡实例ID错误。
InvalidParameter.ListenerIdNotFound 监听器ID错误。
InvalidParameter.LocationNotFound 查找不到符合条件的转发规则。
InvalidParameter.ProtocolCheckFailed 监听器协议检查失败,比如相关协议不支持对应操作。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Duplicate 参数值有重复。
InvalidParameterValue.Length 参数长度错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。