public class ClbClient extends AbstractClient
gson, HTTP_RSP_OK, SDK_VERSION
Constructor and Description |
---|
ClbClient(Credential credential,
String region)
构造client
|
ClbClient(Credential credential,
String region,
ClientProfile profile)
构造client
|
Modifier and Type | Method and Description |
---|---|
AutoRewriteResponse |
AutoRewrite(AutoRewriteRequest req)
用户需要先创建出一个HTTPS:443监听器,并在其下创建转发规则。通过调用本接口,系统会自动创建出一个HTTP:80监听器(如果之前不存在),并在其下创建转发规则,与HTTPS:443监听器下的Domains(在入参中指定)对应。创建成功后可以通过HTTP:80地址自动跳转为HTTPS:443地址进行访问。
|
BatchModifyTargetWeightResponse |
BatchModifyTargetWeight(BatchModifyTargetWeightRequest req)
BatchModifyTargetWeight接口用于批量修改负载均衡监听器绑定的后端机器的转发权重,暂时只支持HTTP/HTTPS监听器。不支持传统型负载均衡。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
CreateListenerResponse |
CreateListener(CreateListenerRequest req)
在一个负载均衡实例下创建监听器。
本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
CreateLoadBalancerResponse |
CreateLoadBalancer(CreateLoadBalancerRequest req)
CreateLoadBalancer 接口用来创建负载均衡实例。为了使用负载均衡服务,您必须购买一个或多个负载均衡实例。成功调用该接口后,会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为:公网、内网。详情可参考产品说明中的产品类型。
注意:(1)指定可用区申请负载均衡、跨zone容灾【如需使用,请提交工单( https://console.cloud.tencent.com/workorder/category )申请】;(2)目前只有北京、上海、广州支持IPv6;
本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。
|
CreateRuleResponse |
CreateRule(CreateRuleRequest req)
CreateRule 接口用于在一个已存在的负载均衡七层监听器下创建转发规则,七层监听器中,后端服务必须绑定到规则上而非监听器上。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeleteListenerResponse |
DeleteListener(DeleteListenerRequest req)
本接口用来删除负载均衡实例下的监听器(四层和七层)。
本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DeleteLoadBalancerResponse |
DeleteLoadBalancer(DeleteLoadBalancerRequest req)
DeleteLoadBalancer 接口用以删除指定的一个或多个负载均衡实例。
本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DeleteRewriteResponse |
DeleteRewrite(DeleteRewriteRequest req)
DeleteRewrite 接口支持删除指定转发规则之间的重定向关系。
|
DeleteRuleResponse |
DeleteRule(DeleteRuleRequest req)
DeleteRule 接口用来删除负载均衡实例七层监听器下的转发规则。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeregisterTargetsResponse |
DeregisterTargets(DeregisterTargetsRequest req)
DeregisterTargets 接口用来将一台或多台后端服务从负载均衡的监听器或转发规则上解绑,对于四层监听器,只需指定监听器ID即可,对于七层监听器,还需通过LocationId或Domain+Url指定转发规则。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeregisterTargetsFromClassicalLBResponse |
DeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req)
DeregisterTargetsFromClassicalLB 接口用于解绑负载均衡后端服务。
本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DescribeClassicalLBByInstanceIdResponse |
DescribeClassicalLBByInstanceId(DescribeClassicalLBByInstanceIdRequest req)
DescribeClassicalLBByInstanceId用于通过后端实例ID获取传统型负载均衡ID列表
|
DescribeClassicalLBHealthStatusResponse |
DescribeClassicalLBHealthStatus(DescribeClassicalLBHealthStatusRequest req)
DescribeClassicalLBHealthStatus用于获取传统型负载均衡后端的健康状态
|
DescribeClassicalLBListenersResponse |
DescribeClassicalLBListeners(DescribeClassicalLBListenersRequest req)
DescribeClassicalLBListeners 接口用于获取传统型负载均衡的监听器信息。
|
DescribeClassicalLBTargetsResponse |
DescribeClassicalLBTargets(DescribeClassicalLBTargetsRequest req)
DescribeClassicalLBTargets用于获取传统型负载均衡绑定的后端服务
|
DescribeListenersResponse |
DescribeListeners(DescribeListenersRequest req)
DescribeListeners 接口可根据负载均衡器 ID,监听器的协议或端口作为过滤条件获取监听器列表。如果不指定任何过滤条件,默认返该负载均衡器下的默认数据长度(20 个)的监听器。
|
DescribeLoadBalancersResponse |
DescribeLoadBalancers(DescribeLoadBalancersRequest req)
查询负载均衡实例列表
|
DescribeRewriteResponse |
DescribeRewrite(DescribeRewriteRequest req)
DescribeRewrite 接口可根据负载均衡实例ID,查询一个负载均衡实例下转发规则的重定向关系。如果不指定监听器ID或转发规则ID,则返回该负载均衡实例下的所有重定向关系。
|
DescribeTargetHealthResponse |
DescribeTargetHealth(DescribeTargetHealthRequest req)
DescribeTargetHealth 接口用来获取负载均衡后端服务的健康检查结果,不支持传统型负载均衡。
|
DescribeTargetsResponse |
DescribeTargets(DescribeTargetsRequest req)
DescribeTargets 接口用来查询负载均衡实例的某些监听器绑定的后端服务列表。
|
DescribeTaskStatusResponse |
DescribeTaskStatus(DescribeTaskStatusRequest req)
本接口用于查询异步任务的执行状态,对于非查询类的接口(创建/删除负载均衡实例、监听器、规则以及绑定或解绑后端服务等),在接口调用成功后,都需要使用本接口查询任务最终是否执行成功。
|
ManualRewriteResponse |
ManualRewrite(ManualRewriteRequest req)
用户手动配置原访问地址和重定向地址,系统自动将原访问地址的请求重定向至对应路径的目的地址。同一域名下可以配置多条路径作为重定向策略,实现http/https之间请求的自动跳转。设置重定向时,需满足如下约束条件:若A已经重定向至B,则A不能再重定向至C(除非先删除老的重定向关系,再建立新的重定向关系),B不能重定向至任何其它地址。
|
ModifyDomainResponse |
ModifyDomain(ModifyDomainRequest req)
ModifyDomain接口用来修改负载均衡七层监听器下的域名。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyListenerResponse |
ModifyListener(ModifyListenerRequest req)
ModifyListener接口用来修改负载均衡监听器的属性,包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyLoadBalancerAttributesResponse |
ModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest req)
修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
|
ModifyRuleResponse |
ModifyRule(ModifyRuleRequest req)
ModifyRule 接口用来修改负载均衡七层监听器下的转发规则的各项属性,包括转发路径、健康检查属性、转发策略等。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyTargetPortResponse |
ModifyTargetPort(ModifyTargetPortRequest req)
ModifyTargetPort接口用于修改监听器绑定的后端服务的端口。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyTargetWeightResponse |
ModifyTargetWeight(ModifyTargetWeightRequest req)
ModifyTargetWeight 接口用于修改负载均衡绑定的后端服务的转发权重。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
RegisterTargetsResponse |
RegisterTargets(RegisterTargetsRequest req)
RegisterTargets 接口用来将一台或多台后端服务绑定到负载均衡的监听器(或7层转发规则),在此之前您需要先行创建相关的4层监听器或7层转发规则。对于四层监听器(TCP、UDP),只需指定监听器ID即可,对于七层监听器(HTTP、HTTPS),还需通过LocationId或者Domain+Url指定转发规则。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
|
RegisterTargetsWithClassicalLBResponse |
RegisterTargetsWithClassicalLB(RegisterTargetsWithClassicalLBRequest req)
RegisterTargetsWithClassicalLB 接口用于绑定后端服务到传统型负载均衡。
本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
ReplaceCertForLoadBalancersResponse |
ReplaceCertForLoadBalancers(ReplaceCertForLoadBalancersRequest req)
ReplaceCertForLoadBalancers 接口用以替换负载均衡实例所关联的证书,对于各个地域的负载均衡,如果指定的老的证书ID与其有关联关系,则会先解除关联,再建立新证书与该负载均衡的关联关系。
此接口支持替换服务端证书或客户端证书。
需要使用的新证书,可以通过传入证书ID来指定,如果不指定证书ID,则必须传入证书内容等相关信息,用以新建证书并绑定至负载均衡。
注:本接口仅可从广州地域调用,其他地域存在域名解析问题,会报错。
|
SetLoadBalancerSecurityGroupsResponse |
SetLoadBalancerSecurityGroups(SetLoadBalancerSecurityGroupsRequest req)
SetLoadBalancerSecurityGroups 接口支持对一个公网负载均衡实例执行设置(绑定、解绑)安全组操作。查询一个负载均衡实例目前已绑定的安全组,可使用 DescribeLoadBalancers 接口。本接口是set语义,
绑定操作时,入参需要传入负载均衡实例要绑定的所有安全组(已绑定的+新增绑定的)。
解绑操作时,入参需要传入负载均衡实例执行解绑后所绑定的所有安全组;如果要解绑所有安全组,可不传此参数,或传入空数组。注意:内网负载均衡不支持绑定安全组。
|
SetSecurityGroupForLoadbalancersResponse |
SetSecurityGroupForLoadbalancers(SetSecurityGroupForLoadbalancersRequest req)
绑定或解绑一个安全组到多个公网负载均衡实例。注意:内网负载均衡不支持绑定安全组。
|
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion
public ClbClient(Credential credential, String region)
credential
- 认证信息实例region
- 产品地域public ClbClient(Credential credential, String region, ClientProfile profile)
credential
- 认证信息实例region
- 产品地域profile
- 配置实例public AutoRewriteResponse AutoRewrite(AutoRewriteRequest req) throws TencentCloudSDKException
req
- AutoRewriteRequestTencentCloudSDKException
public BatchModifyTargetWeightResponse BatchModifyTargetWeight(BatchModifyTargetWeightRequest req) throws TencentCloudSDKException
req
- BatchModifyTargetWeightRequestTencentCloudSDKException
public CreateListenerResponse CreateListener(CreateListenerRequest req) throws TencentCloudSDKException
req
- CreateListenerRequestTencentCloudSDKException
public CreateLoadBalancerResponse CreateLoadBalancer(CreateLoadBalancerRequest req) throws TencentCloudSDKException
req
- CreateLoadBalancerRequestTencentCloudSDKException
public CreateRuleResponse CreateRule(CreateRuleRequest req) throws TencentCloudSDKException
req
- CreateRuleRequestTencentCloudSDKException
public DeleteListenerResponse DeleteListener(DeleteListenerRequest req) throws TencentCloudSDKException
req
- DeleteListenerRequestTencentCloudSDKException
public DeleteLoadBalancerResponse DeleteLoadBalancer(DeleteLoadBalancerRequest req) throws TencentCloudSDKException
req
- DeleteLoadBalancerRequestTencentCloudSDKException
public DeleteRewriteResponse DeleteRewrite(DeleteRewriteRequest req) throws TencentCloudSDKException
req
- DeleteRewriteRequestTencentCloudSDKException
public DeleteRuleResponse DeleteRule(DeleteRuleRequest req) throws TencentCloudSDKException
req
- DeleteRuleRequestTencentCloudSDKException
public DeregisterTargetsResponse DeregisterTargets(DeregisterTargetsRequest req) throws TencentCloudSDKException
req
- DeregisterTargetsRequestTencentCloudSDKException
public DeregisterTargetsFromClassicalLBResponse DeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req) throws TencentCloudSDKException
req
- DeregisterTargetsFromClassicalLBRequestTencentCloudSDKException
public DescribeClassicalLBByInstanceIdResponse DescribeClassicalLBByInstanceId(DescribeClassicalLBByInstanceIdRequest req) throws TencentCloudSDKException
req
- DescribeClassicalLBByInstanceIdRequestTencentCloudSDKException
public DescribeClassicalLBHealthStatusResponse DescribeClassicalLBHealthStatus(DescribeClassicalLBHealthStatusRequest req) throws TencentCloudSDKException
req
- DescribeClassicalLBHealthStatusRequestTencentCloudSDKException
public DescribeClassicalLBListenersResponse DescribeClassicalLBListeners(DescribeClassicalLBListenersRequest req) throws TencentCloudSDKException
req
- DescribeClassicalLBListenersRequestTencentCloudSDKException
public DescribeClassicalLBTargetsResponse DescribeClassicalLBTargets(DescribeClassicalLBTargetsRequest req) throws TencentCloudSDKException
req
- DescribeClassicalLBTargetsRequestTencentCloudSDKException
public DescribeListenersResponse DescribeListeners(DescribeListenersRequest req) throws TencentCloudSDKException
req
- DescribeListenersRequestTencentCloudSDKException
public DescribeLoadBalancersResponse DescribeLoadBalancers(DescribeLoadBalancersRequest req) throws TencentCloudSDKException
req
- DescribeLoadBalancersRequestTencentCloudSDKException
public DescribeRewriteResponse DescribeRewrite(DescribeRewriteRequest req) throws TencentCloudSDKException
req
- DescribeRewriteRequestTencentCloudSDKException
public DescribeTargetHealthResponse DescribeTargetHealth(DescribeTargetHealthRequest req) throws TencentCloudSDKException
req
- DescribeTargetHealthRequestTencentCloudSDKException
public DescribeTargetsResponse DescribeTargets(DescribeTargetsRequest req) throws TencentCloudSDKException
req
- DescribeTargetsRequestTencentCloudSDKException
public DescribeTaskStatusResponse DescribeTaskStatus(DescribeTaskStatusRequest req) throws TencentCloudSDKException
req
- DescribeTaskStatusRequestTencentCloudSDKException
public ManualRewriteResponse ManualRewrite(ManualRewriteRequest req) throws TencentCloudSDKException
req
- ManualRewriteRequestTencentCloudSDKException
public ModifyDomainResponse ModifyDomain(ModifyDomainRequest req) throws TencentCloudSDKException
req
- ModifyDomainRequestTencentCloudSDKException
public ModifyListenerResponse ModifyListener(ModifyListenerRequest req) throws TencentCloudSDKException
req
- ModifyListenerRequestTencentCloudSDKException
public ModifyLoadBalancerAttributesResponse ModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest req) throws TencentCloudSDKException
req
- ModifyLoadBalancerAttributesRequestTencentCloudSDKException
public ModifyRuleResponse ModifyRule(ModifyRuleRequest req) throws TencentCloudSDKException
req
- ModifyRuleRequestTencentCloudSDKException
public ModifyTargetPortResponse ModifyTargetPort(ModifyTargetPortRequest req) throws TencentCloudSDKException
req
- ModifyTargetPortRequestTencentCloudSDKException
public ModifyTargetWeightResponse ModifyTargetWeight(ModifyTargetWeightRequest req) throws TencentCloudSDKException
req
- ModifyTargetWeightRequestTencentCloudSDKException
public RegisterTargetsResponse RegisterTargets(RegisterTargetsRequest req) throws TencentCloudSDKException
req
- RegisterTargetsRequestTencentCloudSDKException
public RegisterTargetsWithClassicalLBResponse RegisterTargetsWithClassicalLB(RegisterTargetsWithClassicalLBRequest req) throws TencentCloudSDKException
req
- RegisterTargetsWithClassicalLBRequestTencentCloudSDKException
public ReplaceCertForLoadBalancersResponse ReplaceCertForLoadBalancers(ReplaceCertForLoadBalancersRequest req) throws TencentCloudSDKException
req
- ReplaceCertForLoadBalancersRequestTencentCloudSDKException
public SetLoadBalancerSecurityGroupsResponse SetLoadBalancerSecurityGroups(SetLoadBalancerSecurityGroupsRequest req) throws TencentCloudSDKException
req
- SetLoadBalancerSecurityGroupsRequestTencentCloudSDKException
public SetSecurityGroupForLoadbalancersResponse SetSecurityGroupForLoadbalancers(SetSecurityGroupForLoadbalancersRequest req) throws TencentCloudSDKException
req
- SetSecurityGroupForLoadbalancersRequestTencentCloudSDKException
Copyright © 2019. All rights reserved.