ClbClient (tencentcloud-sdk-java 3.0.55 API)

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 and Description
`ClbClient(Credential credential, String region)` 构造client
`ClbClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateListenerResponse`	`CreateListener(CreateListenerRequest req)` 在一个负载均衡实例下创建监听器。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`CreateLoadBalancerResponse`	`CreateLoadBalancer(CreateLoadBalancerRequest req)` CreateLoadBalancer 接口用来创建负载均衡实例。为了使用负载均衡服务，您必须要购买一个或者多个负载均衡实例。通过成功调用该接口，会返回负载均衡实例的唯一 ID。用户可以购买的负载均衡实例类型分为：公网（应用型）、内网（应用型）。可以参考产品说明的产品类型。本接口成功返回后，可使用查询负载均衡实例列表接口DescribeLoadBalancers查询负载均衡实例的状态，以确定是否创建成功。
`CreateRuleResponse`	`CreateRule(CreateRuleRequest req)` CreateRule 接口用于在一个已存在的应用型负载均衡七层监听器下创建转发规则，七层监听器中，后端机器必须绑定到规则上而非监听器上。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`DeleteListenerResponse`	`DeleteListener(DeleteListenerRequest req)` 本接口用来删除应用型（四层和七层）负载均衡实例下的监听器。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`DeleteLoadBalancerResponse`	`DeleteLoadBalancer(DeleteLoadBalancerRequest req)` DeleteLoadBalancer 接口用来删除用户指定的一个负载均衡实例。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`DeleteRuleResponse`	`DeleteRule(DeleteRuleRequest req)` DeleteRule 接口用来删除应用型负载均衡实例七层监听器下的转发规则。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`DeregisterTargetsResponse`	`DeregisterTargets(DeregisterTargetsRequest req)` DeregisterTargets 接口用来将一台或多台后端机器从应用型负载均衡的监听器上解绑，对于四层监听器（TCP、UDP），只需指定监听器ID即可，对于七层监听器（HTTP、HTTPS），还需通过LocationId或者Domain+Url指定转发规则。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`DeregisterTargetsFromClassicalLBResponse`	`DeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req)` DeregisterTargetsFromClassicalLB用于解绑后端服务器
`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)` 查询负载均衡实例列表
`DescribeTargetsResponse`	`DescribeTargets(DescribeTargetsRequest req)` DescribeTargets 接口用来查询应用型负载均衡实例的某些监听器后端绑定的机器列表。
`DescribeTaskStatusResponse`	`DescribeTaskStatus(DescribeTaskStatusRequest req)` 本接口用于查询异步执行任务的状态，对于非查询类的接口（创建/删除负载均衡实例、监听器、规则以及绑定或解绑后端机器等），在调用成功后都需要使用本接口查询任务是否最终执行成功。
`ModifyDomainResponse`	`ModifyDomain(ModifyDomainRequest req)` ModifyDomain接口用来修改应用型负载均衡七层监听器下的域名。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`ModifyListenerResponse`	`ModifyListener(ModifyListenerRequest req)` ModifyListener接口用来修改应用型负载均衡监听器的属性，包括监听器名称、健康检查参数、证书信息、转发策略等。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`ModifyLoadBalancerAttributesResponse`	`ModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest req)` 修改负载均衡实例的属性，目前仅用于修改负载均衡实例的名称。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`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 接口用来将一台或多台后端机器注册到应用型负载均衡的监听器，对于四层监听器（TCP、UDP），只需指定监听器ID即可，对于七层监听器（HTTP、HTTPS），还需通过LocationId或者Domain+Url指定转发规则。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
`RegisterTargetsWithClassicalLBResponse`	`RegisterTargetsWithClassicalLB(RegisterTargetsWithClassicalLBRequest req)` RegisterTargetsWithClassicalLB用于绑定后端服务到传统型负载均衡

Methods inherited from class com.tencentcloudapi.common.AbstractClient
getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClbClient
```
public ClbClient(Credential credential,
                 String region)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
  - ClbClient
```
public ClbClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- Method Detail
  - 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。用户可以购买的负载均衡实例类型分为：公网（应用型）、内网（应用型）。可以参考产品说明的产品类型。本接口成功返回后，可使用查询负载均衡实例列表接口DescribeLoadBalancers查询负载均衡实例的状态，以确定是否创建成功。
    
    Parameters:
    
    req - CreateLoadBalancerRequest
    
    Returns:
    
    CreateLoadBalancerResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateRule
```
public CreateRuleResponse CreateRule(CreateRuleRequest req)
                              throws TencentCloudSDKException
```
    CreateRule 接口用于在一个已存在的应用型负载均衡七层监听器下创建转发规则，七层监听器中，后端机器必须绑定到规则上而非监听器上。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
    
    Parameters:
    
    req - CreateRuleRequest
    
    Returns:
    
    CreateRuleResponse
    
    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
  - DeleteRule
```
public DeleteRuleResponse DeleteRule(DeleteRuleRequest req)
                              throws TencentCloudSDKException
```
    DeleteRule 接口用来删除应用型负载均衡实例七层监听器下的转发规则。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
    
    Parameters:
    
    req - DeleteRuleRequest
    
    Returns:
    
    DeleteRuleResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeregisterTargets
```
public DeregisterTargetsResponse DeregisterTargets(DeregisterTargetsRequest req)
                                            throws TencentCloudSDKException
```
    DeregisterTargets 接口用来将一台或多台后端机器从应用型负载均衡的监听器上解绑，对于四层监听器（TCP、UDP），只需指定监听器ID即可，对于七层监听器（HTTP、HTTPS），还需通过LocationId或者Domain+Url指定转发规则。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
    
    Parameters:
    
    req - DeregisterTargetsRequest
    
    Returns:
    
    DeregisterTargetsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeregisterTargetsFromClassicalLB
```
public DeregisterTargetsFromClassicalLBResponse DeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req)
                                                                          throws TencentCloudSDKException
```
    DeregisterTargetsFromClassicalLB用于解绑后端服务器
    
    Parameters:
    
    req - DeregisterTargetsFromClassicalLBRequest
    
    Returns:
    
    DeregisterTargetsFromClassicalLBResponse
    
    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
  - DescribeListeners
```
public DescribeListenersResponse DescribeListeners(DescribeListenersRequest req)
                                            throws TencentCloudSDKException
```
    DescribeListeners 接口可根据负载均衡器 ID，监听器的协议或者端口作为过滤条件获取监听器列表。如果不指定任何过滤条件，默认返该负载均衡器下的默认数据长度（20 个）的监听器。
    
    Parameters:
    
    req - DescribeListenersRequest
    
    Returns:
    
    DescribeListenersResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLoadBalancers
```
public DescribeLoadBalancersResponse DescribeLoadBalancers(DescribeLoadBalancersRequest req)
                                                    throws TencentCloudSDKException
```
    查询负载均衡实例列表
    
    Parameters:
    
    req - DescribeLoadBalancersRequest
    
    Returns:
    
    DescribeLoadBalancersResponse
    
    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
  - ModifyDomain
```
public ModifyDomainResponse ModifyDomain(ModifyDomainRequest req)
                                  throws TencentCloudSDKException
```
    ModifyDomain接口用来修改应用型负载均衡七层监听器下的域名。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
    
    Parameters:
    
    req - ModifyDomainRequest
    
    Returns:
    
    ModifyDomainResponse
    
    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
  - ModifyRule
```
public ModifyRuleResponse ModifyRule(ModifyRuleRequest req)
                              throws TencentCloudSDKException
```
    ModifyRule 接口用来修改应用型负载均衡七层监听器下的转发规则的各项属性，包括转发路径、健康检查属性、转发策略等。本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
    
    Parameters:
    
    req - ModifyRuleRequest
    
    Returns:
    
    ModifyRuleResponse
    
    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
  - RegisterTargets
```
public RegisterTargetsResponse RegisterTargets(RegisterTargetsRequest req)
                                        throws TencentCloudSDKException
```
    RegisterTargets 接口用来将一台或多台后端机器注册到应用型负载均衡的监听器，对于四层监听器（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用于绑定后端服务到传统型负载均衡
    
    Parameters:
    
    req - RegisterTargetsWithClassicalLBRequest
    
    Returns:
    
    RegisterTargetsWithClassicalLBResponse
    
    Throws:
    
    TencentCloudSDKException

Class ClbClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

ClbClient

ClbClient

Method Detail

CreateListener

CreateLoadBalancer

CreateRule

DeleteListener

DeleteLoadBalancer

DeleteRule

DeregisterTargets

DeregisterTargetsFromClassicalLB

DescribeClassicalLBByInstanceId

DescribeClassicalLBHealthStatus

DescribeClassicalLBListeners

DescribeClassicalLBTargets

DescribeListeners

DescribeLoadBalancers

DescribeTargets

DescribeTaskStatus

ModifyDomain

ModifyListener

ModifyLoadBalancerAttributes

ModifyRule

ModifyTargetPort

ModifyTargetWeight

RegisterTargets

RegisterTargetsWithClassicalLB