Class ClbClient
- java.lang.Object
-
- com.tencentcloudapi.common.AbstractClient
-
- com.tencentcloudapi.clb.v20180317.ClbClient
-
public class ClbClient extends AbstractClient
-
-
Field Summary
-
Fields inherited from class com.tencentcloudapi.common.AbstractClient
gson, HTTP_RSP_OK, SDK_VERSION
-
-
Constructor Summary
Constructors Constructor Description ClbClient(Credential credential, String region)ClbClient(Credential credential, String region, ClientProfile profile)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AssociateTargetGroupsResponseAssociateTargetGroups(AssociateTargetGroupsRequest req)本接口(AssociateTargetGroups)用来将目标组绑定到负载均衡的监听器(四层协议)或转发规则(七层协议)上。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。AutoRewriteResponseAutoRewrite(AutoRewriteRequest req)用户需要先创建出一个HTTPS:443监听器,并在其下创建转发规则。通过调用本接口,系统会自动创建出一个HTTP:80监听器(如果之前不存在),并在其下创建转发规则,与HTTPS:443监听器下的Domains(在入参中指定)对应。创建成功后可以通过HTTP:80地址自动跳转为HTTPS:443地址进行访问。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。BatchDeregisterTargetsResponseBatchDeregisterTargets(BatchDeregisterTargetsRequest req)批量解绑四七层后端服务。批量解绑的资源数量上限为500。只支持VPC网络负载均衡。BatchModifyTargetWeightResponseBatchModifyTargetWeight(BatchModifyTargetWeightRequest req)BatchModifyTargetWeight 接口用于批量修改负载均衡监听器绑定的后端机器的转发权重。批量修改的资源数量上限为500。本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
负载均衡的4层和7层监听器支持此接口,传统型负载均衡不支持。BatchRegisterTargetsResponseBatchRegisterTargets(BatchRegisterTargetsRequest req)批量绑定虚拟主机或弹性网卡,支持跨域绑定,支持四层、七层(TCP、UDP、HTTP、HTTPS)协议绑定。批量绑定的资源数量上限为500。只支持VPC网络负载均衡。CloneLoadBalancerResponseCloneLoadBalancer(CloneLoadBalancerRequest req)克隆负载均衡实例,根据指定的负载均衡实例,复制出相同规则和绑定关系的负载均衡实例。克隆接口为异步操作,克隆的数据以调用CloneLoadBalancer时为准,如果调用CloneLoadBalancer后克隆CLB发生变化,变化规则不会克隆。 限制说明: 实例属性维度限制 仅支持克隆按量计费实例,不支持包年包月实例。 不支持克隆未关联实例计费项的 CLB。 不支持克隆传统型负载均衡实例和高防 CLB。 不支持克隆基础网络类型的实例。 不支持克隆 IPv6、IPv6 NAT64 版本以及混绑的实例。 个性化配置、重定向配置、安全组默认放通开关的配置将不会被克隆,需重新配置。 执行克隆操作前,请确保实例上没有使用已过期证书,否则会导致克隆失败。 监听器维度限制 不支持克隆监听器为 QUIC 类型和端口段的实例。 不支持监听器为 TCP_SSL 的内网型负载均衡的实例。 不支持克隆七层监听器没有转发规则的实例。 当实例的监听器个数超过50个时,不支持克隆。 后端服务维度限制 不支持克隆绑定的后端服务类型为目标组和 SCF 云函数的实例。 通过接口调用: BGP带宽包必须传带宽包id 独占集群克隆必须传对应的参数,否则按共享型创建 功能内测中,[申请开通](https://console.cloud.tencent.com/workorder/category?level1_id=6&level2_id=163&source=0&data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20CLB&step=1)。CreateClsLogSetResponseCreateClsLogSet(CreateClsLogSetRequest req)创建CLB专有日志集,此日志集用于存储CLB的日志。CreateListenerResponseCreateListener(CreateListenerRequest req)在一个负载均衡实例下创建监听器。 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。CreateLoadBalancerResponseCreateLoadBalancer(CreateLoadBalancerRequest req)本接口(CreateLoadBalancer)用来创建负载均衡实例(本接口只支持购买按量计费的负载均衡,包年包月的负载均衡请通过控制台购买)。为了使用负载均衡服务,您必须购买一个或多个负载均衡实例。成功调用该接口后,会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为:公网、内网。详情可参考产品说明中的产品类型。 注意:(1)指定可用区申请负载均衡、跨zone容灾(仅香港支持)【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】;(2)目前只有北京、上海、广州支持IPv6;(3)一个账号在每个地域的默认购买配额为:公网100个,内网100个。 本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。CreateLoadBalancerSnatIpsResponseCreateLoadBalancerSnatIps(CreateLoadBalancerSnatIpsRequest req)针对SnatPro负载均衡,这个接口用于添加SnatIp,如果负载均衡没有开启SnatPro,添加SnatIp后会自动开启。 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。CreateRuleResponseCreateRule(CreateRuleRequest req)CreateRule 接口用于在一个已存在的负载均衡七层监听器下创建转发规则,七层监听器中,后端服务必须绑定到规则上而非监听器上。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。CreateTargetGroupResponseCreateTargetGroup(CreateTargetGroupRequest req)创建目标组。该功能正在内测中,如需使用,请通过[工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=6&level2_id=163&source=0&data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20LB&step=1)。CreateTopicResponseCreateTopic(CreateTopicRequest req)创建主题,默认开启全文索引和键值索引。如果不存在CLB专有日志集,则创建失败。DeleteListenerResponseDeleteListener(DeleteListenerRequest req)本接口用来删除负载均衡实例下的监听器(四层和七层)。 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。DeleteLoadBalancerResponseDeleteLoadBalancer(DeleteLoadBalancerRequest req)DeleteLoadBalancer 接口用以删除指定的一个或多个负载均衡实例。成功删除后,会把负载均衡实例下的监听器、转发规则一起删除,并把后端服务解绑。 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。DeleteLoadBalancerListenersResponseDeleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest req)该接口支持删除负载均衡的多个监听器。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。DeleteLoadBalancerSnatIpsResponseDeleteLoadBalancerSnatIps(DeleteLoadBalancerSnatIpsRequest req)这个接口用于删除SnatPro的负载均衡的SnatIp。 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。DeleteRewriteResponseDeleteRewrite(DeleteRewriteRequest req)DeleteRewrite 接口支持删除指定转发规则之间的重定向关系。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。DeleteRuleResponseDeleteRule(DeleteRuleRequest req)DeleteRule 接口用来删除负载均衡实例七层监听器下的转发规则。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。DeleteTargetGroupsResponseDeleteTargetGroups(DeleteTargetGroupsRequest req)删除目标组DeregisterFunctionTargetsResponseDeregisterFunctionTargets(DeregisterFunctionTargetsRequest req)DeregisterFunctionTargets 接口用来将一个云函数从负载均衡的转发规则上解绑,对于七层监听器,还需通过 LocationId 或 Domain+Url 指定转发规则。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
限制说明: - 仅广州、深圳金融、上海、上海金融、北京、成都、中国香港、新加坡、孟买、东京、硅谷地域支持绑定 SCF。 - 仅标准账户类型支持绑定 SCF,传统账户类型不支持。建议升级为标准账户类型,详情可参见 [账户类型升级说明](https://cloud.tencent.com/document/product/1199/49090)。 - 传统型负载均衡不支持绑定 SCF。 - 基础网络类型不支持绑定 SCF。 - CLB 默认支持绑定同地域下的所有 SCF,可支持跨 VPC 绑定 SCF,不支持跨地域绑定。 - 目前仅 IPv4、IPv6 NAT64 版本的负载均衡支持绑定 SCF,IPv6 版本的暂不支持。 - 仅七层(HTTP、HTTPS)监听器支持绑定 SCF,四层(TCP、UDP、TCP SSL)监听器和七层 QUIC 监听器不支持。 - CLB 绑定 SCF 仅支持绑定“Event 函数”类型的云函数。DeregisterTargetGroupInstancesResponseDeregisterTargetGroupInstances(DeregisterTargetGroupInstancesRequest req)从目标组中解绑服务器。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。DeregisterTargetsResponseDeregisterTargets(DeregisterTargetsRequest req)DeregisterTargets 接口用来将一台或多台后端服务从负载均衡的监听器或转发规则上解绑,对于四层监听器,只需指定监听器ID即可,对于七层监听器,还需通过LocationId或Domain+Url指定转发规则。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。DeregisterTargetsFromClassicalLBResponseDeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req)DeregisterTargetsFromClassicalLB 接口用于解绑负载均衡后端服务。本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。DescribeBlockIPListResponseDescribeBlockIPList(DescribeBlockIPListRequest req)查询一个负载均衡所封禁的IP列表(黑名单)。(接口灰度中,如需使用请提工单)DescribeBlockIPTaskResponseDescribeBlockIPTask(DescribeBlockIPTaskRequest req)根据 ModifyBlockIPList 接口返回的异步任务的ID,查询封禁IP(黑名单)异步任务的执行状态。(接口灰度中,如需使用请提工单)DescribeClassicalLBByInstanceIdResponseDescribeClassicalLBByInstanceId(DescribeClassicalLBByInstanceIdRequest req)DescribeClassicalLBByInstanceId用于通过后端实例ID获取传统型负载均衡ID列表。DescribeClassicalLBHealthStatusResponseDescribeClassicalLBHealthStatus(DescribeClassicalLBHealthStatusRequest req)DescribeClassicalLBHealthStatus用于获取传统型负载均衡后端的健康状态DescribeClassicalLBListenersResponseDescribeClassicalLBListeners(DescribeClassicalLBListenersRequest req)DescribeClassicalLBListeners 接口用于获取传统型负载均衡的监听器信息。DescribeClassicalLBTargetsResponseDescribeClassicalLBTargets(DescribeClassicalLBTargetsRequest req)DescribeClassicalLBTargets用于获取传统型负载均衡绑定的后端服务。DescribeClsLogSetResponseDescribeClsLogSet(DescribeClsLogSetRequest req)获取用户的CLB专有日志集。DescribeClusterResourcesResponseDescribeClusterResources(DescribeClusterResourcesRequest req)查询独占集群中的资源列表,支持按集群ID、VIP、负载均衡ID、是否闲置为过滤条件检索。DescribeCrossTargetsResponseDescribeCrossTargets(DescribeCrossTargetsRequest req)查询跨域2.0版本云联网后端子机和网卡信息。DescribeCustomizedConfigAssociateListResponseDescribeCustomizedConfigAssociateList(DescribeCustomizedConfigAssociateListRequest req)拉取配置绑定的 server 或 location,如果 domain 存在,结果将根据 domain 过滤。或拉取配置绑定的 loadbalancer。DescribeCustomizedConfigListResponseDescribeCustomizedConfigList(DescribeCustomizedConfigListRequest req)拉取个性化配置列表,返回用户 AppId 下指定类型的配置。DescribeExclusiveClustersResponseDescribeExclusiveClusters(DescribeExclusiveClustersRequest req)查询集群信息列表,支持以集群类型、集群唯一ID、集群名字、集群标签、集群内vip、集群内负载均衡唯一id、集群网络类型、可用区等条件进行检索DescribeIdleLoadBalancersResponseDescribeIdleLoadBalancers(DescribeIdleLoadBalancersRequest req)闲置实例是指创建超过7天后付费实例,且没有创建规则或创建规则没有绑定子机的负载均衡实例。DescribeLBListenersResponseDescribeLBListeners(DescribeLBListenersRequest req)查询后端云主机或弹性网卡绑定的负载均衡,支持弹性网卡和cvm查询。DescribeListenersResponseDescribeListeners(DescribeListenersRequest req)DescribeListeners 接口可根据负载均衡器 ID、监听器的协议或端口作为过滤条件获取监听器列表。如果不指定任何过滤条件,则返回该负载均衡实例下的所有监听器。DescribeLoadBalancerListByCertIdResponseDescribeLoadBalancerListByCertId(DescribeLoadBalancerListByCertIdRequest req)根据证书ID查询其在一个地域中所关联到负载均衡实例列表DescribeLoadBalancerOverviewResponseDescribeLoadBalancerOverview(DescribeLoadBalancerOverviewRequest req)查询运行中、隔离中、即将到期和负载均衡总数。DescribeLoadBalancersResponseDescribeLoadBalancers(DescribeLoadBalancersRequest req)查询一个地域的负载均衡实例列表。DescribeLoadBalancersDetailResponseDescribeLoadBalancersDetail(DescribeLoadBalancersDetailRequest req)查询负载均衡的详细信息,包括监听器,规则及后端目标。DescribeLoadBalancerTrafficResponseDescribeLoadBalancerTraffic(DescribeLoadBalancerTrafficRequest req)查询账号下的高流量负载均衡,返回前10个负载均衡。如果是子账号登录,只返回子账号有权限的负载均衡。DescribeQuotaResponseDescribeQuota(DescribeQuotaRequest req)查询用户当前地域下的各项配额DescribeResourcesResponseDescribeResources(DescribeResourcesRequest req)查询用户在当前地域支持可用区列表和资源列表。DescribeRewriteResponseDescribeRewrite(DescribeRewriteRequest req)DescribeRewrite 接口可根据负载均衡实例ID,查询一个负载均衡实例下转发规则的重定向关系。如果不指定监听器ID或转发规则ID,则返回该负载均衡实例下的所有重定向关系。DescribeTargetGroupInstancesResponseDescribeTargetGroupInstances(DescribeTargetGroupInstancesRequest req)获取目标组绑定的服务器信息DescribeTargetGroupListResponseDescribeTargetGroupList(DescribeTargetGroupListRequest req)获取目标组列表DescribeTargetGroupsResponseDescribeTargetGroups(DescribeTargetGroupsRequest req)查询目标组信息DescribeTargetHealthResponseDescribeTargetHealth(DescribeTargetHealthRequest req)DescribeTargetHealth 接口用来获取负载均衡后端服务的健康检查结果,不支持传统型负载均衡。DescribeTargetsResponseDescribeTargets(DescribeTargetsRequest req)DescribeTargets 接口用来查询负载均衡实例的某些监听器绑定的后端服务列表。DescribeTaskStatusResponseDescribeTaskStatus(DescribeTaskStatusRequest req)本接口用于查询异步任务的执行状态,对于非查询类的接口(创建/删除负载均衡实例、监听器、规则以及绑定或解绑后端服务等),在接口调用成功后,都需要使用本接口查询任务最终是否执行成功。DisassociateTargetGroupsResponseDisassociateTargetGroups(DisassociateTargetGroupsRequest req)解除规则的目标组关联关系。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。ManualRewriteResponseManualRewrite(ManualRewriteRequest req)用户手动配置原访问地址和重定向地址,系统自动将原访问地址的请求重定向至对应路径的目的地址。同一域名下可以配置多条路径作为重定向策略,实现http/https之间请求的自动跳转。设置重定向时,需满足如下约束条件:若A已经重定向至B,则A不能再重定向至C(除非先删除老的重定向关系,再建立新的重定向关系),B不能重定向至任何其它地址。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。MigrateClassicalLoadBalancersResponseMigrateClassicalLoadBalancers(MigrateClassicalLoadBalancersRequest req)本接口将传统型负载均衡迁移成(原应用型)负载均衡 本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。ModifyBlockIPListResponseModifyBlockIPList(ModifyBlockIPListRequest req)修改负载均衡的IP(client IP)封禁黑名单列表,一个转发规则最多支持封禁 2000000 个IP,及黑名单容量为 2000000。 (接口灰度中,如需使用请提工单)ModifyDomainResponseModifyDomain(ModifyDomainRequest req)ModifyDomain接口用来修改负载均衡七层监听器下的域名。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。ModifyDomainAttributesResponseModifyDomainAttributes(ModifyDomainAttributesRequest req)ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性,如修改域名、修改DefaultServer、开启/关闭Http2、修改证书。 本接口为异步接口,本接口返回成功后,需以返回的RequestId为入参,调用DescribeTaskStatus接口查询本次任务是否成功。ModifyFunctionTargetsResponseModifyFunctionTargets(ModifyFunctionTargetsRequest req)修改负载均衡转发规则上所绑定的云函数。ModifyListenerResponseModifyListener(ModifyListenerRequest req)ModifyListener接口用来修改负载均衡监听器的属性,包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。ModifyLoadBalancerAttributesResponseModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest req)修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。ModifyLoadBalancerMixIpTargetResponseModifyLoadBalancerMixIpTarget(ModifyLoadBalancerMixIpTargetRequest req)修改IPv6FullChain负载均衡7层监听器支持混绑IPv4/IPv6目标特性。ModifyLoadBalancerSlaResponseModifyLoadBalancerSla(ModifyLoadBalancerSlaRequest req)本接口(ModifyLoadBalancerSla)用于将按量计费模式的共享型实例升级为性能容量型实例。
限制条件: - 本接口只支持升级按量计费的CLB实例,包年包月的CLB实例升级请通过控制台进行升级。 - 升级为性能容量型实例后,不支持再回退到共享型实例。 - 传统型负载均衡实例不支持升级为性能容量型实例。ModifyLoadBalancersProjectResponseModifyLoadBalancersProject(ModifyLoadBalancersProjectRequest req)修改一个或多个负载均衡实例所属项目。ModifyRuleResponseModifyRule(ModifyRuleRequest req)ModifyRule 接口用来修改负载均衡七层监听器下的转发规则的各项属性,包括转发路径、健康检查属性、转发策略等。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。ModifyTargetGroupAttributeResponseModifyTargetGroupAttribute(ModifyTargetGroupAttributeRequest req)修改目标组的名称或者默认端口属性ModifyTargetGroupInstancesPortResponseModifyTargetGroupInstancesPort(ModifyTargetGroupInstancesPortRequest req)批量修改目标组服务器端口。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。ModifyTargetGroupInstancesWeightResponseModifyTargetGroupInstancesWeight(ModifyTargetGroupInstancesWeightRequest req)批量修改目标组的服务器权重。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。ModifyTargetPortResponseModifyTargetPort(ModifyTargetPortRequest req)ModifyTargetPort接口用于修改监听器绑定的后端服务的端口。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。ModifyTargetWeightResponseModifyTargetWeight(ModifyTargetWeightRequest req)ModifyTargetWeight 接口用于修改负载均衡绑定的后端服务的转发权重。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。RegisterFunctionTargetsResponseRegisterFunctionTargets(RegisterFunctionTargetsRequest req)RegisterFunctionTargets 接口用来将一个云函数绑定到负载均衡的7层转发规则,在此之前您需要先行创建相关的7层监听器(HTTP、HTTPS)和转发规则。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
限制说明: - 仅广州、深圳金融、上海、上海金融、北京、成都、中国香港、新加坡、孟买、东京、硅谷地域支持绑定 SCF。 - 仅标准账户类型支持绑定 SCF,传统账户类型不支持。建议升级为标准账户类型,详情可参见 [账户类型升级说明](https://cloud.tencent.com/document/product/1199/49090)。 - 传统型负载均衡不支持绑定 SCF。 - 基础网络类型不支持绑定 SCF。 - CLB 默认支持绑定同地域下的所有 SCF,可支持跨 VPC 绑定 SCF,不支持跨地域绑定。 - 目前仅 IPv4、IPv6 NAT64 版本的负载均衡支持绑定 SCF,IPv6 版本的暂不支持。 - 仅七层(HTTP、HTTPS)监听器支持绑定 SCF,四层(TCP、UDP、TCP SSL)监听器和七层 QUIC 监听器不支持。 - CLB 绑定 SCF 仅支持绑定“Event 函数”类型的云函数。RegisterTargetGroupInstancesResponseRegisterTargetGroupInstances(RegisterTargetGroupInstancesRequest req)注册服务器到目标组。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。RegisterTargetsResponseRegisterTargets(RegisterTargetsRequest req)RegisterTargets 接口用来将一台或多台后端服务绑定到负载均衡的监听器(或7层转发规则),在此之前您需要先行创建相关的4层监听器或7层转发规则。对于四层监听器(TCP、UDP),只需指定监听器ID即可,对于七层监听器(HTTP、HTTPS),还需通过LocationId或者Domain+Url指定转发规则。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。RegisterTargetsWithClassicalLBResponseRegisterTargetsWithClassicalLB(RegisterTargetsWithClassicalLBRequest req)RegisterTargetsWithClassicalLB 接口用于绑定后端服务到传统型负载均衡。本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。ReplaceCertForLoadBalancersResponseReplaceCertForLoadBalancers(ReplaceCertForLoadBalancersRequest req)ReplaceCertForLoadBalancers 接口用以替换负载均衡实例所关联的证书,对于各个地域的负载均衡,如果指定的老的证书ID与其有关联关系,则会先解除关联,再建立新证书与该负载均衡的关联关系。 此接口支持替换服务端证书或客户端证书。 需要使用的新证书,可以通过传入证书ID来指定,如果不指定证书ID,则必须传入证书内容等相关信息,用以新建证书并绑定至负载均衡。 注:本接口仅可从广州地域调用。SetCustomizedConfigForLoadBalancerResponseSetCustomizedConfigForLoadBalancer(SetCustomizedConfigForLoadBalancerRequest req)负载均衡维度的个性化配置相关操作:创建、删除、修改、绑定、解绑SetLoadBalancerClsLogResponseSetLoadBalancerClsLog(SetLoadBalancerClsLogRequest req)增加、删除、更新负载均衡的日志服务(CLS)主题。SetLoadBalancerSecurityGroupsResponseSetLoadBalancerSecurityGroups(SetLoadBalancerSecurityGroupsRequest req)SetLoadBalancerSecurityGroups 接口支持对一个公网负载均衡实例执行设置(绑定、解绑)安全组操作。查询一个负载均衡实例目前已绑定的安全组,可使用 DescribeLoadBalancers 接口。本接口是set语义, 绑定操作时,入参需要传入负载均衡实例要绑定的所有安全组(已绑定的+新增绑定的)。 解绑操作时,入参需要传入负载均衡实例执行解绑后所绑定的所有安全组;如果要解绑所有安全组,可不传此参数,或传入空数组。注意:内网负载均衡不支持绑定安全组。SetSecurityGroupForLoadbalancersResponseSetSecurityGroupForLoadbalancers(SetSecurityGroupForLoadbalancersRequest req)绑定或解绑一个安全组到多个公网负载均衡实例。注意:内网负载均衡不支持绑定安全组。-
Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, retry, setClientProfile, setCredential, setRegion, setRegionBreaker
-
-
-
-
Constructor Detail
-
ClbClient
public ClbClient(Credential credential, String region)
-
ClbClient
public ClbClient(Credential credential, String region, ClientProfile profile)
-
-
Method Detail
-
AssociateTargetGroups
public AssociateTargetGroupsResponse AssociateTargetGroups(AssociateTargetGroupsRequest req) throws TencentCloudSDKException
本接口(AssociateTargetGroups)用来将目标组绑定到负载均衡的监听器(四层协议)或转发规则(七层协议)上。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- AssociateTargetGroupsRequest- Returns:
- AssociateTargetGroupsResponse
- Throws:
TencentCloudSDKException
-
AutoRewrite
public AutoRewriteResponse AutoRewrite(AutoRewriteRequest req) throws TencentCloudSDKException
用户需要先创建出一个HTTPS:443监听器,并在其下创建转发规则。通过调用本接口,系统会自动创建出一个HTTP:80监听器(如果之前不存在),并在其下创建转发规则,与HTTPS:443监听器下的Domains(在入参中指定)对应。创建成功后可以通过HTTP:80地址自动跳转为HTTPS:443地址进行访问。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- AutoRewriteRequest- Returns:
- AutoRewriteResponse
- Throws:
TencentCloudSDKException
-
BatchDeregisterTargets
public BatchDeregisterTargetsResponse BatchDeregisterTargets(BatchDeregisterTargetsRequest req) throws TencentCloudSDKException
批量解绑四七层后端服务。批量解绑的资源数量上限为500。只支持VPC网络负载均衡。- Parameters:
req- BatchDeregisterTargetsRequest- Returns:
- BatchDeregisterTargetsResponse
- Throws:
TencentCloudSDKException
-
BatchModifyTargetWeight
public BatchModifyTargetWeightResponse BatchModifyTargetWeight(BatchModifyTargetWeightRequest req) throws TencentCloudSDKException
BatchModifyTargetWeight 接口用于批量修改负载均衡监听器绑定的后端机器的转发权重。批量修改的资源数量上限为500。本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
负载均衡的4层和7层监听器支持此接口,传统型负载均衡不支持。- Parameters:
req- BatchModifyTargetWeightRequest- Returns:
- BatchModifyTargetWeightResponse
- Throws:
TencentCloudSDKException
-
BatchRegisterTargets
public BatchRegisterTargetsResponse BatchRegisterTargets(BatchRegisterTargetsRequest req) throws TencentCloudSDKException
批量绑定虚拟主机或弹性网卡,支持跨域绑定,支持四层、七层(TCP、UDP、HTTP、HTTPS)协议绑定。批量绑定的资源数量上限为500。只支持VPC网络负载均衡。- Parameters:
req- BatchRegisterTargetsRequest- Returns:
- BatchRegisterTargetsResponse
- Throws:
TencentCloudSDKException
-
CloneLoadBalancer
public CloneLoadBalancerResponse CloneLoadBalancer(CloneLoadBalancerRequest req) throws TencentCloudSDKException
克隆负载均衡实例,根据指定的负载均衡实例,复制出相同规则和绑定关系的负载均衡实例。克隆接口为异步操作,克隆的数据以调用CloneLoadBalancer时为准,如果调用CloneLoadBalancer后克隆CLB发生变化,变化规则不会克隆。 限制说明: 实例属性维度限制 仅支持克隆按量计费实例,不支持包年包月实例。 不支持克隆未关联实例计费项的 CLB。 不支持克隆传统型负载均衡实例和高防 CLB。 不支持克隆基础网络类型的实例。 不支持克隆 IPv6、IPv6 NAT64 版本以及混绑的实例。 个性化配置、重定向配置、安全组默认放通开关的配置将不会被克隆,需重新配置。 执行克隆操作前,请确保实例上没有使用已过期证书,否则会导致克隆失败。 监听器维度限制 不支持克隆监听器为 QUIC 类型和端口段的实例。 不支持监听器为 TCP_SSL 的内网型负载均衡的实例。 不支持克隆七层监听器没有转发规则的实例。 当实例的监听器个数超过50个时,不支持克隆。 后端服务维度限制 不支持克隆绑定的后端服务类型为目标组和 SCF 云函数的实例。 通过接口调用: BGP带宽包必须传带宽包id 独占集群克隆必须传对应的参数,否则按共享型创建 功能内测中,[申请开通](https://console.cloud.tencent.com/workorder/category?level1_id=6&level2_id=163&source=0&data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20CLB&step=1)。- Parameters:
req- CloneLoadBalancerRequest- Returns:
- CloneLoadBalancerResponse
- Throws:
TencentCloudSDKException
-
CreateClsLogSet
public CreateClsLogSetResponse CreateClsLogSet(CreateClsLogSetRequest req) throws TencentCloudSDKException
创建CLB专有日志集,此日志集用于存储CLB的日志。- Parameters:
req- CreateClsLogSetRequest- Returns:
- CreateClsLogSetResponse
- Throws:
TencentCloudSDKException
-
CreateListener
public CreateListenerResponse CreateListener(CreateListenerRequest req) throws TencentCloudSDKException
在一个负载均衡实例下创建监听器。 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- CreateListenerRequest- Returns:
- CreateListenerResponse
- Throws:
TencentCloudSDKException
-
CreateLoadBalancer
public CreateLoadBalancerResponse CreateLoadBalancer(CreateLoadBalancerRequest req) throws TencentCloudSDKException
本接口(CreateLoadBalancer)用来创建负载均衡实例(本接口只支持购买按量计费的负载均衡,包年包月的负载均衡请通过控制台购买)。为了使用负载均衡服务,您必须购买一个或多个负载均衡实例。成功调用该接口后,会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为:公网、内网。详情可参考产品说明中的产品类型。 注意:(1)指定可用区申请负载均衡、跨zone容灾(仅香港支持)【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】;(2)目前只有北京、上海、广州支持IPv6;(3)一个账号在每个地域的默认购买配额为:公网100个,内网100个。 本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。- Parameters:
req- CreateLoadBalancerRequest- Returns:
- CreateLoadBalancerResponse
- Throws:
TencentCloudSDKException
-
CreateLoadBalancerSnatIps
public CreateLoadBalancerSnatIpsResponse CreateLoadBalancerSnatIps(CreateLoadBalancerSnatIpsRequest req) throws TencentCloudSDKException
针对SnatPro负载均衡,这个接口用于添加SnatIp,如果负载均衡没有开启SnatPro,添加SnatIp后会自动开启。 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- CreateLoadBalancerSnatIpsRequest- Returns:
- CreateLoadBalancerSnatIpsResponse
- Throws:
TencentCloudSDKException
-
CreateRule
public CreateRuleResponse CreateRule(CreateRuleRequest req) throws TencentCloudSDKException
CreateRule 接口用于在一个已存在的负载均衡七层监听器下创建转发规则,七层监听器中,后端服务必须绑定到规则上而非监听器上。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- CreateRuleRequest- Returns:
- CreateRuleResponse
- Throws:
TencentCloudSDKException
-
CreateTargetGroup
public CreateTargetGroupResponse CreateTargetGroup(CreateTargetGroupRequest req) throws TencentCloudSDKException
创建目标组。该功能正在内测中,如需使用,请通过[工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=6&level2_id=163&source=0&data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20LB&step=1)。- Parameters:
req- CreateTargetGroupRequest- Returns:
- CreateTargetGroupResponse
- Throws:
TencentCloudSDKException
-
CreateTopic
public CreateTopicResponse CreateTopic(CreateTopicRequest req) throws TencentCloudSDKException
创建主题,默认开启全文索引和键值索引。如果不存在CLB专有日志集,则创建失败。- Parameters:
req- CreateTopicRequest- Returns:
- CreateTopicResponse
- Throws:
TencentCloudSDKException
-
DeleteListener
public DeleteListenerResponse DeleteListener(DeleteListenerRequest req) throws TencentCloudSDKException
本接口用来删除负载均衡实例下的监听器(四层和七层)。 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- DeleteListenerRequest- Returns:
- DeleteListenerResponse
- Throws:
TencentCloudSDKException
-
DeleteLoadBalancer
public DeleteLoadBalancerResponse DeleteLoadBalancer(DeleteLoadBalancerRequest req) throws TencentCloudSDKException
DeleteLoadBalancer 接口用以删除指定的一个或多个负载均衡实例。成功删除后,会把负载均衡实例下的监听器、转发规则一起删除,并把后端服务解绑。 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- DeleteLoadBalancerRequest- Returns:
- DeleteLoadBalancerResponse
- Throws:
TencentCloudSDKException
-
DeleteLoadBalancerListeners
public DeleteLoadBalancerListenersResponse DeleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest req) throws TencentCloudSDKException
该接口支持删除负载均衡的多个监听器。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- DeleteLoadBalancerListenersRequest- Returns:
- DeleteLoadBalancerListenersResponse
- Throws:
TencentCloudSDKException
-
DeleteLoadBalancerSnatIps
public DeleteLoadBalancerSnatIpsResponse DeleteLoadBalancerSnatIps(DeleteLoadBalancerSnatIpsRequest req) throws TencentCloudSDKException
这个接口用于删除SnatPro的负载均衡的SnatIp。 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- DeleteLoadBalancerSnatIpsRequest- Returns:
- DeleteLoadBalancerSnatIpsResponse
- Throws:
TencentCloudSDKException
-
DeleteRewrite
public DeleteRewriteResponse DeleteRewrite(DeleteRewriteRequest req) throws TencentCloudSDKException
DeleteRewrite 接口支持删除指定转发规则之间的重定向关系。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- DeleteRewriteRequest- Returns:
- DeleteRewriteResponse
- Throws:
TencentCloudSDKException
-
DeleteRule
public DeleteRuleResponse DeleteRule(DeleteRuleRequest req) throws TencentCloudSDKException
DeleteRule 接口用来删除负载均衡实例七层监听器下的转发规则。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- DeleteRuleRequest- Returns:
- DeleteRuleResponse
- Throws:
TencentCloudSDKException
-
DeleteTargetGroups
public DeleteTargetGroupsResponse DeleteTargetGroups(DeleteTargetGroupsRequest req) throws TencentCloudSDKException
删除目标组- Parameters:
req- DeleteTargetGroupsRequest- Returns:
- DeleteTargetGroupsResponse
- Throws:
TencentCloudSDKException
-
DeregisterFunctionTargets
public DeregisterFunctionTargetsResponse DeregisterFunctionTargets(DeregisterFunctionTargetsRequest req) throws TencentCloudSDKException
DeregisterFunctionTargets 接口用来将一个云函数从负载均衡的转发规则上解绑,对于七层监听器,还需通过 LocationId 或 Domain+Url 指定转发规则。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
限制说明: - 仅广州、深圳金融、上海、上海金融、北京、成都、中国香港、新加坡、孟买、东京、硅谷地域支持绑定 SCF。 - 仅标准账户类型支持绑定 SCF,传统账户类型不支持。建议升级为标准账户类型,详情可参见 [账户类型升级说明](https://cloud.tencent.com/document/product/1199/49090)。 - 传统型负载均衡不支持绑定 SCF。 - 基础网络类型不支持绑定 SCF。 - CLB 默认支持绑定同地域下的所有 SCF,可支持跨 VPC 绑定 SCF,不支持跨地域绑定。 - 目前仅 IPv4、IPv6 NAT64 版本的负载均衡支持绑定 SCF,IPv6 版本的暂不支持。 - 仅七层(HTTP、HTTPS)监听器支持绑定 SCF,四层(TCP、UDP、TCP SSL)监听器和七层 QUIC 监听器不支持。 - CLB 绑定 SCF 仅支持绑定“Event 函数”类型的云函数。- Parameters:
req- DeregisterFunctionTargetsRequest- Returns:
- DeregisterFunctionTargetsResponse
- Throws:
TencentCloudSDKException
-
DeregisterTargetGroupInstances
public DeregisterTargetGroupInstancesResponse DeregisterTargetGroupInstances(DeregisterTargetGroupInstancesRequest req) throws TencentCloudSDKException
从目标组中解绑服务器。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- DeregisterTargetGroupInstancesRequest- Returns:
- DeregisterTargetGroupInstancesResponse
- Throws:
TencentCloudSDKException
-
DeregisterTargets
public DeregisterTargetsResponse DeregisterTargets(DeregisterTargetsRequest req) throws TencentCloudSDKException
DeregisterTargets 接口用来将一台或多台后端服务从负载均衡的监听器或转发规则上解绑,对于四层监听器,只需指定监听器ID即可,对于七层监听器,还需通过LocationId或Domain+Url指定转发规则。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- DeregisterTargetsRequest- Returns:
- DeregisterTargetsResponse
- Throws:
TencentCloudSDKException
-
DeregisterTargetsFromClassicalLB
public DeregisterTargetsFromClassicalLBResponse DeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req) throws TencentCloudSDKException
DeregisterTargetsFromClassicalLB 接口用于解绑负载均衡后端服务。本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- DeregisterTargetsFromClassicalLBRequest- Returns:
- DeregisterTargetsFromClassicalLBResponse
- Throws:
TencentCloudSDKException
-
DescribeBlockIPList
public DescribeBlockIPListResponse DescribeBlockIPList(DescribeBlockIPListRequest req) throws TencentCloudSDKException
查询一个负载均衡所封禁的IP列表(黑名单)。(接口灰度中,如需使用请提工单)- Parameters:
req- DescribeBlockIPListRequest- Returns:
- DescribeBlockIPListResponse
- Throws:
TencentCloudSDKException
-
DescribeBlockIPTask
public DescribeBlockIPTaskResponse DescribeBlockIPTask(DescribeBlockIPTaskRequest req) throws TencentCloudSDKException
根据 ModifyBlockIPList 接口返回的异步任务的ID,查询封禁IP(黑名单)异步任务的执行状态。(接口灰度中,如需使用请提工单)- Parameters:
req- DescribeBlockIPTaskRequest- Returns:
- DescribeBlockIPTaskResponse
- Throws:
TencentCloudSDKException
-
DescribeClassicalLBByInstanceId
public DescribeClassicalLBByInstanceIdResponse DescribeClassicalLBByInstanceId(DescribeClassicalLBByInstanceIdRequest req) throws TencentCloudSDKException
DescribeClassicalLBByInstanceId用于通过后端实例ID获取传统型负载均衡ID列表。- Parameters:
req- DescribeClassicalLBByInstanceIdRequest- Returns:
- DescribeClassicalLBByInstanceIdResponse
- Throws:
TencentCloudSDKException
-
DescribeClassicalLBHealthStatus
public DescribeClassicalLBHealthStatusResponse DescribeClassicalLBHealthStatus(DescribeClassicalLBHealthStatusRequest req) throws TencentCloudSDKException
DescribeClassicalLBHealthStatus用于获取传统型负载均衡后端的健康状态- Parameters:
req- DescribeClassicalLBHealthStatusRequest- Returns:
- DescribeClassicalLBHealthStatusResponse
- Throws:
TencentCloudSDKException
-
DescribeClassicalLBListeners
public DescribeClassicalLBListenersResponse DescribeClassicalLBListeners(DescribeClassicalLBListenersRequest req) throws TencentCloudSDKException
DescribeClassicalLBListeners 接口用于获取传统型负载均衡的监听器信息。- Parameters:
req- DescribeClassicalLBListenersRequest- Returns:
- DescribeClassicalLBListenersResponse
- Throws:
TencentCloudSDKException
-
DescribeClassicalLBTargets
public DescribeClassicalLBTargetsResponse DescribeClassicalLBTargets(DescribeClassicalLBTargetsRequest req) throws TencentCloudSDKException
DescribeClassicalLBTargets用于获取传统型负载均衡绑定的后端服务。- Parameters:
req- DescribeClassicalLBTargetsRequest- Returns:
- DescribeClassicalLBTargetsResponse
- Throws:
TencentCloudSDKException
-
DescribeClsLogSet
public DescribeClsLogSetResponse DescribeClsLogSet(DescribeClsLogSetRequest req) throws TencentCloudSDKException
获取用户的CLB专有日志集。- Parameters:
req- DescribeClsLogSetRequest- Returns:
- DescribeClsLogSetResponse
- Throws:
TencentCloudSDKException
-
DescribeClusterResources
public DescribeClusterResourcesResponse DescribeClusterResources(DescribeClusterResourcesRequest req) throws TencentCloudSDKException
查询独占集群中的资源列表,支持按集群ID、VIP、负载均衡ID、是否闲置为过滤条件检索。- Parameters:
req- DescribeClusterResourcesRequest- Returns:
- DescribeClusterResourcesResponse
- Throws:
TencentCloudSDKException
-
DescribeCrossTargets
public DescribeCrossTargetsResponse DescribeCrossTargets(DescribeCrossTargetsRequest req) throws TencentCloudSDKException
查询跨域2.0版本云联网后端子机和网卡信息。- Parameters:
req- DescribeCrossTargetsRequest- Returns:
- DescribeCrossTargetsResponse
- Throws:
TencentCloudSDKException
-
DescribeCustomizedConfigAssociateList
public DescribeCustomizedConfigAssociateListResponse DescribeCustomizedConfigAssociateList(DescribeCustomizedConfigAssociateListRequest req) throws TencentCloudSDKException
拉取配置绑定的 server 或 location,如果 domain 存在,结果将根据 domain 过滤。或拉取配置绑定的 loadbalancer。- Parameters:
req- DescribeCustomizedConfigAssociateListRequest- Returns:
- DescribeCustomizedConfigAssociateListResponse
- Throws:
TencentCloudSDKException
-
DescribeCustomizedConfigList
public DescribeCustomizedConfigListResponse DescribeCustomizedConfigList(DescribeCustomizedConfigListRequest req) throws TencentCloudSDKException
拉取个性化配置列表,返回用户 AppId 下指定类型的配置。- Parameters:
req- DescribeCustomizedConfigListRequest- Returns:
- DescribeCustomizedConfigListResponse
- Throws:
TencentCloudSDKException
-
DescribeExclusiveClusters
public DescribeExclusiveClustersResponse DescribeExclusiveClusters(DescribeExclusiveClustersRequest req) throws TencentCloudSDKException
查询集群信息列表,支持以集群类型、集群唯一ID、集群名字、集群标签、集群内vip、集群内负载均衡唯一id、集群网络类型、可用区等条件进行检索- Parameters:
req- DescribeExclusiveClustersRequest- Returns:
- DescribeExclusiveClustersResponse
- Throws:
TencentCloudSDKException
-
DescribeIdleLoadBalancers
public DescribeIdleLoadBalancersResponse DescribeIdleLoadBalancers(DescribeIdleLoadBalancersRequest req) throws TencentCloudSDKException
闲置实例是指创建超过7天后付费实例,且没有创建规则或创建规则没有绑定子机的负载均衡实例。- Parameters:
req- DescribeIdleLoadBalancersRequest- Returns:
- DescribeIdleLoadBalancersResponse
- Throws:
TencentCloudSDKException
-
DescribeLBListeners
public DescribeLBListenersResponse DescribeLBListeners(DescribeLBListenersRequest req) throws TencentCloudSDKException
查询后端云主机或弹性网卡绑定的负载均衡,支持弹性网卡和cvm查询。- Parameters:
req- DescribeLBListenersRequest- Returns:
- DescribeLBListenersResponse
- Throws:
TencentCloudSDKException
-
DescribeListeners
public DescribeListenersResponse DescribeListeners(DescribeListenersRequest req) throws TencentCloudSDKException
DescribeListeners 接口可根据负载均衡器 ID、监听器的协议或端口作为过滤条件获取监听器列表。如果不指定任何过滤条件,则返回该负载均衡实例下的所有监听器。- Parameters:
req- DescribeListenersRequest- Returns:
- DescribeListenersResponse
- Throws:
TencentCloudSDKException
-
DescribeLoadBalancerListByCertId
public DescribeLoadBalancerListByCertIdResponse DescribeLoadBalancerListByCertId(DescribeLoadBalancerListByCertIdRequest req) throws TencentCloudSDKException
根据证书ID查询其在一个地域中所关联到负载均衡实例列表- Parameters:
req- DescribeLoadBalancerListByCertIdRequest- Returns:
- DescribeLoadBalancerListByCertIdResponse
- Throws:
TencentCloudSDKException
-
DescribeLoadBalancerOverview
public DescribeLoadBalancerOverviewResponse DescribeLoadBalancerOverview(DescribeLoadBalancerOverviewRequest req) throws TencentCloudSDKException
查询运行中、隔离中、即将到期和负载均衡总数。- Parameters:
req- DescribeLoadBalancerOverviewRequest- Returns:
- DescribeLoadBalancerOverviewResponse
- Throws:
TencentCloudSDKException
-
DescribeLoadBalancerTraffic
public DescribeLoadBalancerTrafficResponse DescribeLoadBalancerTraffic(DescribeLoadBalancerTrafficRequest req) throws TencentCloudSDKException
查询账号下的高流量负载均衡,返回前10个负载均衡。如果是子账号登录,只返回子账号有权限的负载均衡。- Parameters:
req- DescribeLoadBalancerTrafficRequest- Returns:
- DescribeLoadBalancerTrafficResponse
- Throws:
TencentCloudSDKException
-
DescribeLoadBalancers
public DescribeLoadBalancersResponse DescribeLoadBalancers(DescribeLoadBalancersRequest req) throws TencentCloudSDKException
查询一个地域的负载均衡实例列表。- Parameters:
req- DescribeLoadBalancersRequest- Returns:
- DescribeLoadBalancersResponse
- Throws:
TencentCloudSDKException
-
DescribeLoadBalancersDetail
public DescribeLoadBalancersDetailResponse DescribeLoadBalancersDetail(DescribeLoadBalancersDetailRequest req) throws TencentCloudSDKException
查询负载均衡的详细信息,包括监听器,规则及后端目标。- Parameters:
req- DescribeLoadBalancersDetailRequest- Returns:
- DescribeLoadBalancersDetailResponse
- Throws:
TencentCloudSDKException
-
DescribeQuota
public DescribeQuotaResponse DescribeQuota(DescribeQuotaRequest req) throws TencentCloudSDKException
查询用户当前地域下的各项配额- Parameters:
req- DescribeQuotaRequest- Returns:
- DescribeQuotaResponse
- Throws:
TencentCloudSDKException
-
DescribeResources
public DescribeResourcesResponse DescribeResources(DescribeResourcesRequest req) throws TencentCloudSDKException
查询用户在当前地域支持可用区列表和资源列表。- Parameters:
req- DescribeResourcesRequest- Returns:
- DescribeResourcesResponse
- Throws:
TencentCloudSDKException
-
DescribeRewrite
public DescribeRewriteResponse DescribeRewrite(DescribeRewriteRequest req) throws TencentCloudSDKException
DescribeRewrite 接口可根据负载均衡实例ID,查询一个负载均衡实例下转发规则的重定向关系。如果不指定监听器ID或转发规则ID,则返回该负载均衡实例下的所有重定向关系。- Parameters:
req- DescribeRewriteRequest- Returns:
- DescribeRewriteResponse
- Throws:
TencentCloudSDKException
-
DescribeTargetGroupInstances
public DescribeTargetGroupInstancesResponse DescribeTargetGroupInstances(DescribeTargetGroupInstancesRequest req) throws TencentCloudSDKException
获取目标组绑定的服务器信息- Parameters:
req- DescribeTargetGroupInstancesRequest- Returns:
- DescribeTargetGroupInstancesResponse
- Throws:
TencentCloudSDKException
-
DescribeTargetGroupList
public DescribeTargetGroupListResponse DescribeTargetGroupList(DescribeTargetGroupListRequest req) throws TencentCloudSDKException
获取目标组列表- Parameters:
req- DescribeTargetGroupListRequest- Returns:
- DescribeTargetGroupListResponse
- Throws:
TencentCloudSDKException
-
DescribeTargetGroups
public DescribeTargetGroupsResponse DescribeTargetGroups(DescribeTargetGroupsRequest req) throws TencentCloudSDKException
查询目标组信息- Parameters:
req- DescribeTargetGroupsRequest- Returns:
- DescribeTargetGroupsResponse
- Throws:
TencentCloudSDKException
-
DescribeTargetHealth
public DescribeTargetHealthResponse DescribeTargetHealth(DescribeTargetHealthRequest req) throws TencentCloudSDKException
DescribeTargetHealth 接口用来获取负载均衡后端服务的健康检查结果,不支持传统型负载均衡。- Parameters:
req- DescribeTargetHealthRequest- Returns:
- DescribeTargetHealthResponse
- Throws:
TencentCloudSDKException
-
DescribeTargets
public DescribeTargetsResponse DescribeTargets(DescribeTargetsRequest req) throws TencentCloudSDKException
DescribeTargets 接口用来查询负载均衡实例的某些监听器绑定的后端服务列表。- Parameters:
req- DescribeTargetsRequest- Returns:
- DescribeTargetsResponse
- Throws:
TencentCloudSDKException
-
DescribeTaskStatus
public DescribeTaskStatusResponse DescribeTaskStatus(DescribeTaskStatusRequest req) throws TencentCloudSDKException
本接口用于查询异步任务的执行状态,对于非查询类的接口(创建/删除负载均衡实例、监听器、规则以及绑定或解绑后端服务等),在接口调用成功后,都需要使用本接口查询任务最终是否执行成功。- Parameters:
req- DescribeTaskStatusRequest- Returns:
- DescribeTaskStatusResponse
- Throws:
TencentCloudSDKException
-
DisassociateTargetGroups
public DisassociateTargetGroupsResponse DisassociateTargetGroups(DisassociateTargetGroupsRequest req) throws TencentCloudSDKException
解除规则的目标组关联关系。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- DisassociateTargetGroupsRequest- Returns:
- DisassociateTargetGroupsResponse
- Throws:
TencentCloudSDKException
-
ManualRewrite
public ManualRewriteResponse ManualRewrite(ManualRewriteRequest req) throws TencentCloudSDKException
用户手动配置原访问地址和重定向地址,系统自动将原访问地址的请求重定向至对应路径的目的地址。同一域名下可以配置多条路径作为重定向策略,实现http/https之间请求的自动跳转。设置重定向时,需满足如下约束条件:若A已经重定向至B,则A不能再重定向至C(除非先删除老的重定向关系,再建立新的重定向关系),B不能重定向至任何其它地址。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- ManualRewriteRequest- Returns:
- ManualRewriteResponse
- Throws:
TencentCloudSDKException
-
MigrateClassicalLoadBalancers
public MigrateClassicalLoadBalancersResponse MigrateClassicalLoadBalancers(MigrateClassicalLoadBalancersRequest req) throws TencentCloudSDKException
本接口将传统型负载均衡迁移成(原应用型)负载均衡 本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。- Parameters:
req- MigrateClassicalLoadBalancersRequest- Returns:
- MigrateClassicalLoadBalancersResponse
- Throws:
TencentCloudSDKException
-
ModifyBlockIPList
public ModifyBlockIPListResponse ModifyBlockIPList(ModifyBlockIPListRequest req) throws TencentCloudSDKException
修改负载均衡的IP(client IP)封禁黑名单列表,一个转发规则最多支持封禁 2000000 个IP,及黑名单容量为 2000000。 (接口灰度中,如需使用请提工单)- Parameters:
req- ModifyBlockIPListRequest- Returns:
- ModifyBlockIPListResponse
- Throws:
TencentCloudSDKException
-
ModifyDomain
public ModifyDomainResponse ModifyDomain(ModifyDomainRequest req) throws TencentCloudSDKException
ModifyDomain接口用来修改负载均衡七层监听器下的域名。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- ModifyDomainRequest- Returns:
- ModifyDomainResponse
- Throws:
TencentCloudSDKException
-
ModifyDomainAttributes
public ModifyDomainAttributesResponse ModifyDomainAttributes(ModifyDomainAttributesRequest req) throws TencentCloudSDKException
ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性,如修改域名、修改DefaultServer、开启/关闭Http2、修改证书。 本接口为异步接口,本接口返回成功后,需以返回的RequestId为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- ModifyDomainAttributesRequest- Returns:
- ModifyDomainAttributesResponse
- Throws:
TencentCloudSDKException
-
ModifyFunctionTargets
public ModifyFunctionTargetsResponse ModifyFunctionTargets(ModifyFunctionTargetsRequest req) throws TencentCloudSDKException
修改负载均衡转发规则上所绑定的云函数。- Parameters:
req- ModifyFunctionTargetsRequest- Returns:
- ModifyFunctionTargetsResponse
- Throws:
TencentCloudSDKException
-
ModifyListener
public ModifyListenerResponse ModifyListener(ModifyListenerRequest req) throws TencentCloudSDKException
ModifyListener接口用来修改负载均衡监听器的属性,包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- ModifyListenerRequest- Returns:
- ModifyListenerResponse
- Throws:
TencentCloudSDKException
-
ModifyLoadBalancerAttributes
public ModifyLoadBalancerAttributesResponse ModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest req) throws TencentCloudSDKException
修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- ModifyLoadBalancerAttributesRequest- Returns:
- ModifyLoadBalancerAttributesResponse
- Throws:
TencentCloudSDKException
-
ModifyLoadBalancerMixIpTarget
public ModifyLoadBalancerMixIpTargetResponse ModifyLoadBalancerMixIpTarget(ModifyLoadBalancerMixIpTargetRequest req) throws TencentCloudSDKException
修改IPv6FullChain负载均衡7层监听器支持混绑IPv4/IPv6目标特性。- Parameters:
req- ModifyLoadBalancerMixIpTargetRequest- Returns:
- ModifyLoadBalancerMixIpTargetResponse
- Throws:
TencentCloudSDKException
-
ModifyLoadBalancerSla
public ModifyLoadBalancerSlaResponse ModifyLoadBalancerSla(ModifyLoadBalancerSlaRequest req) throws TencentCloudSDKException
本接口(ModifyLoadBalancerSla)用于将按量计费模式的共享型实例升级为性能容量型实例。
限制条件: - 本接口只支持升级按量计费的CLB实例,包年包月的CLB实例升级请通过控制台进行升级。 - 升级为性能容量型实例后,不支持再回退到共享型实例。 - 传统型负载均衡实例不支持升级为性能容量型实例。- Parameters:
req- ModifyLoadBalancerSlaRequest- Returns:
- ModifyLoadBalancerSlaResponse
- Throws:
TencentCloudSDKException
-
ModifyLoadBalancersProject
public ModifyLoadBalancersProjectResponse ModifyLoadBalancersProject(ModifyLoadBalancersProjectRequest req) throws TencentCloudSDKException
修改一个或多个负载均衡实例所属项目。- Parameters:
req- ModifyLoadBalancersProjectRequest- Returns:
- ModifyLoadBalancersProjectResponse
- Throws:
TencentCloudSDKException
-
ModifyRule
public ModifyRuleResponse ModifyRule(ModifyRuleRequest req) throws TencentCloudSDKException
ModifyRule 接口用来修改负载均衡七层监听器下的转发规则的各项属性,包括转发路径、健康检查属性、转发策略等。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- ModifyRuleRequest- Returns:
- ModifyRuleResponse
- Throws:
TencentCloudSDKException
-
ModifyTargetGroupAttribute
public ModifyTargetGroupAttributeResponse ModifyTargetGroupAttribute(ModifyTargetGroupAttributeRequest req) throws TencentCloudSDKException
修改目标组的名称或者默认端口属性- Parameters:
req- ModifyTargetGroupAttributeRequest- Returns:
- ModifyTargetGroupAttributeResponse
- Throws:
TencentCloudSDKException
-
ModifyTargetGroupInstancesPort
public ModifyTargetGroupInstancesPortResponse ModifyTargetGroupInstancesPort(ModifyTargetGroupInstancesPortRequest req) throws TencentCloudSDKException
批量修改目标组服务器端口。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- ModifyTargetGroupInstancesPortRequest- Returns:
- ModifyTargetGroupInstancesPortResponse
- Throws:
TencentCloudSDKException
-
ModifyTargetGroupInstancesWeight
public ModifyTargetGroupInstancesWeightResponse ModifyTargetGroupInstancesWeight(ModifyTargetGroupInstancesWeightRequest req) throws TencentCloudSDKException
批量修改目标组的服务器权重。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- ModifyTargetGroupInstancesWeightRequest- Returns:
- ModifyTargetGroupInstancesWeightResponse
- Throws:
TencentCloudSDKException
-
ModifyTargetPort
public ModifyTargetPortResponse ModifyTargetPort(ModifyTargetPortRequest req) throws TencentCloudSDKException
ModifyTargetPort接口用于修改监听器绑定的后端服务的端口。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- ModifyTargetPortRequest- Returns:
- ModifyTargetPortResponse
- Throws:
TencentCloudSDKException
-
ModifyTargetWeight
public ModifyTargetWeightResponse ModifyTargetWeight(ModifyTargetWeightRequest req) throws TencentCloudSDKException
ModifyTargetWeight 接口用于修改负载均衡绑定的后端服务的转发权重。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- ModifyTargetWeightRequest- Returns:
- ModifyTargetWeightResponse
- Throws:
TencentCloudSDKException
-
RegisterFunctionTargets
public RegisterFunctionTargetsResponse RegisterFunctionTargets(RegisterFunctionTargetsRequest req) throws TencentCloudSDKException
RegisterFunctionTargets 接口用来将一个云函数绑定到负载均衡的7层转发规则,在此之前您需要先行创建相关的7层监听器(HTTP、HTTPS)和转发规则。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
限制说明: - 仅广州、深圳金融、上海、上海金融、北京、成都、中国香港、新加坡、孟买、东京、硅谷地域支持绑定 SCF。 - 仅标准账户类型支持绑定 SCF,传统账户类型不支持。建议升级为标准账户类型,详情可参见 [账户类型升级说明](https://cloud.tencent.com/document/product/1199/49090)。 - 传统型负载均衡不支持绑定 SCF。 - 基础网络类型不支持绑定 SCF。 - CLB 默认支持绑定同地域下的所有 SCF,可支持跨 VPC 绑定 SCF,不支持跨地域绑定。 - 目前仅 IPv4、IPv6 NAT64 版本的负载均衡支持绑定 SCF,IPv6 版本的暂不支持。 - 仅七层(HTTP、HTTPS)监听器支持绑定 SCF,四层(TCP、UDP、TCP SSL)监听器和七层 QUIC 监听器不支持。 - CLB 绑定 SCF 仅支持绑定“Event 函数”类型的云函数。- Parameters:
req- RegisterFunctionTargetsRequest- Returns:
- RegisterFunctionTargetsResponse
- Throws:
TencentCloudSDKException
-
RegisterTargetGroupInstances
public RegisterTargetGroupInstancesResponse RegisterTargetGroupInstances(RegisterTargetGroupInstancesRequest req) throws TencentCloudSDKException
注册服务器到目标组。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- RegisterTargetGroupInstancesRequest- Returns:
- RegisterTargetGroupInstancesResponse
- Throws:
TencentCloudSDKException
-
RegisterTargets
public RegisterTargetsResponse RegisterTargets(RegisterTargetsRequest req) throws TencentCloudSDKException
RegisterTargets 接口用来将一台或多台后端服务绑定到负载均衡的监听器(或7层转发规则),在此之前您需要先行创建相关的4层监听器或7层转发规则。对于四层监听器(TCP、UDP),只需指定监听器ID即可,对于七层监听器(HTTP、HTTPS),还需通过LocationId或者Domain+Url指定转发规则。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。- Parameters:
req- RegisterTargetsRequest- Returns:
- RegisterTargetsResponse
- Throws:
TencentCloudSDKException
-
RegisterTargetsWithClassicalLB
public RegisterTargetsWithClassicalLBResponse RegisterTargetsWithClassicalLB(RegisterTargetsWithClassicalLBRequest req) throws TencentCloudSDKException
RegisterTargetsWithClassicalLB 接口用于绑定后端服务到传统型负载均衡。本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。- Parameters:
req- RegisterTargetsWithClassicalLBRequest- Returns:
- RegisterTargetsWithClassicalLBResponse
- Throws:
TencentCloudSDKException
-
ReplaceCertForLoadBalancers
public ReplaceCertForLoadBalancersResponse ReplaceCertForLoadBalancers(ReplaceCertForLoadBalancersRequest req) throws TencentCloudSDKException
ReplaceCertForLoadBalancers 接口用以替换负载均衡实例所关联的证书,对于各个地域的负载均衡,如果指定的老的证书ID与其有关联关系,则会先解除关联,再建立新证书与该负载均衡的关联关系。 此接口支持替换服务端证书或客户端证书。 需要使用的新证书,可以通过传入证书ID来指定,如果不指定证书ID,则必须传入证书内容等相关信息,用以新建证书并绑定至负载均衡。 注:本接口仅可从广州地域调用。- Parameters:
req- ReplaceCertForLoadBalancersRequest- Returns:
- ReplaceCertForLoadBalancersResponse
- Throws:
TencentCloudSDKException
-
SetCustomizedConfigForLoadBalancer
public SetCustomizedConfigForLoadBalancerResponse SetCustomizedConfigForLoadBalancer(SetCustomizedConfigForLoadBalancerRequest req) throws TencentCloudSDKException
负载均衡维度的个性化配置相关操作:创建、删除、修改、绑定、解绑- Parameters:
req- SetCustomizedConfigForLoadBalancerRequest- Returns:
- SetCustomizedConfigForLoadBalancerResponse
- Throws:
TencentCloudSDKException
-
SetLoadBalancerClsLog
public SetLoadBalancerClsLogResponse SetLoadBalancerClsLog(SetLoadBalancerClsLogRequest req) throws TencentCloudSDKException
增加、删除、更新负载均衡的日志服务(CLS)主题。- Parameters:
req- SetLoadBalancerClsLogRequest- Returns:
- SetLoadBalancerClsLogResponse
- Throws:
TencentCloudSDKException
-
SetLoadBalancerSecurityGroups
public SetLoadBalancerSecurityGroupsResponse SetLoadBalancerSecurityGroups(SetLoadBalancerSecurityGroupsRequest req) throws TencentCloudSDKException
SetLoadBalancerSecurityGroups 接口支持对一个公网负载均衡实例执行设置(绑定、解绑)安全组操作。查询一个负载均衡实例目前已绑定的安全组,可使用 DescribeLoadBalancers 接口。本接口是set语义, 绑定操作时,入参需要传入负载均衡实例要绑定的所有安全组(已绑定的+新增绑定的)。 解绑操作时,入参需要传入负载均衡实例执行解绑后所绑定的所有安全组;如果要解绑所有安全组,可不传此参数,或传入空数组。注意:内网负载均衡不支持绑定安全组。- Parameters:
req- SetLoadBalancerSecurityGroupsRequest- Returns:
- SetLoadBalancerSecurityGroupsResponse
- Throws:
TencentCloudSDKException
-
SetSecurityGroupForLoadbalancers
public SetSecurityGroupForLoadbalancersResponse SetSecurityGroupForLoadbalancers(SetSecurityGroupForLoadbalancersRequest req) throws TencentCloudSDKException
绑定或解绑一个安全组到多个公网负载均衡实例。注意:内网负载均衡不支持绑定安全组。- Parameters:
req- SetSecurityGroupForLoadbalancersRequest- Returns:
- SetSecurityGroupForLoadbalancersResponse
- Throws:
TencentCloudSDKException
-
-