com.tencentcloudapi.clb.v20180317

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

Method Summary

Modifier and Type	Method and Description
AssociateTargetGroupsResponse	AssociateTargetGroups(AssociateTargetGroupsRequest req) This API is used to bind target groups to CLB listeners (layer-4 protocol) or forwarding rules (layer-7 protocol).
AutoRewriteResponse	AutoRewrite(AutoRewriteRequest req) An HTTPS:443 listener needs to be created first, along with a forwarding rule.
BatchDeregisterTargetsResponse	BatchDeregisterTargets(BatchDeregisterTargetsRequest req) This API is used to unbind layer-4/layer-7 real servers in batches.
BatchModifyTargetWeightResponse	BatchModifyTargetWeight(BatchModifyTargetWeightRequest req) This API is used to modify the forwarding weights of real servers bound to a CLB listener in batches.
BatchRegisterTargetsResponse	BatchRegisterTargets(BatchRegisterTargetsRequest req) This API is used to bind CVM instances or ENIs in batches.
CreateClsLogSetResponse	CreateClsLogSet(CreateClsLogSetRequest req) This API is used to create a CLB exclusive logset for storing CLB logs.
CreateListenerResponse	CreateListener(CreateListenerRequest req) This API is used to create a listener for a CLB instance.
CreateLoadBalancerResponse	CreateLoadBalancer(CreateLoadBalancerRequest req) This API (CreateLoadBalancer) is used to create a CLB instance.
CreateLoadBalancerSnatIpsResponse	CreateLoadBalancerSnatIps(CreateLoadBalancerSnatIpsRequest req) This API is used to add a SNAT IP for a SnatPro CLB instance.
CreateRuleResponse	CreateRule(CreateRuleRequest req) This API (CreateRule) is used to create a forwarding rule under an existing layer-7 CLB listener, where real servers must be bound to the rule instead of the listener.
CreateTargetGroupResponse	CreateTargetGroup(CreateTargetGroupRequest req) This API is used to create a target group.
CreateTopicResponse	CreateTopic(CreateTopicRequest req) This API is used to create a topic with the full-text index and key-value index enabled by default.
DeleteListenerResponse	DeleteListener(DeleteListenerRequest req) This API is used to delete a listener from a CLB instance (layer-4 or layer-7).
DeleteLoadBalancerResponse	DeleteLoadBalancer(DeleteLoadBalancerRequest req) This API (DeleteLoadBalancer) is used to delete one or more specified CLB instances.
DeleteLoadBalancerListenersResponse	DeleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest req) This API is used to delete multiple listeners of a CLB instance.
DeleteLoadBalancerSnatIpsResponse	DeleteLoadBalancerSnatIps(DeleteLoadBalancerSnatIpsRequest req) This API is used to delete a SNAT IP for a SnatPro CLB instance.
DeleteRewriteResponse	DeleteRewrite(DeleteRewriteRequest req) This API (DeleteRewrite) is used to delete the redirection relationship between the specified forwarding rules.
DeleteRuleResponse	DeleteRule(DeleteRuleRequest req) This API (DeleteRule) is used to delete a forwarding rule under a layer-7 CLB instance listener This is an async API.
DeleteTargetGroupsResponse	DeleteTargetGroups(DeleteTargetGroupsRequest req) This API is used to delete a target group.
DeregisterTargetGroupInstancesResponse	DeregisterTargetGroupInstances(DeregisterTargetGroupInstancesRequest req) This API is used to unbind a server from a target group.
DeregisterTargetsResponse	DeregisterTargets(DeregisterTargetsRequest req) This API (DeregisterTargets) is used to unbind one or more real servers from a CLB listener or forwarding rule.
DeregisterTargetsFromClassicalLBResponse	DeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req) This API (DeregisterTargetsFromClassicalLB) is used to unbind real servers from a classic load balancer.
DescribeBlockIPListResponse	DescribeBlockIPList(DescribeBlockIPListRequest req) This API is used to query the list of blocked IPs (blocklist) of a CLB instance.
DescribeBlockIPTaskResponse	DescribeBlockIPTask(DescribeBlockIPTaskRequest req) This API is used to query the execution status of an async IP blocking (blocklisting) task by the async task ID returned by the `ModifyBlockIPList` API.
DescribeClassicalLBByInstanceIdResponse	DescribeClassicalLBByInstanceId(DescribeClassicalLBByInstanceIdRequest req) This API (DescribeClassicalLBByInstanceId) is used to get the list of classic CLB IDs through the real server instance ID.
DescribeClassicalLBHealthStatusResponse	DescribeClassicalLBHealthStatus(DescribeClassicalLBHealthStatusRequest req) This API (DescribeClassicalLBHealthStatus) is used to get the real server health status of a classic CLB
DescribeClassicalLBListenersResponse	DescribeClassicalLBListeners(DescribeClassicalLBListenersRequest req) This API (DescribeClassicalLBListeners) is used to get the listener information of a classic CLB.
DescribeClassicalLBTargetsResponse	DescribeClassicalLBTargets(DescribeClassicalLBTargetsRequest req) This API (DescribeClassicalLBTargets) is used to get the real servers bound to a classic CLB.
DescribeClsLogSetResponse	DescribeClsLogSet(DescribeClsLogSetRequest req) This API is used to get the CLB dedicated logset.
DescribeListenersResponse	DescribeListeners(DescribeListenersRequest req) This API is used to get the list of listeners by CLB instance ID, listener protocol, or port.
DescribeLoadBalancerListByCertIdResponse	DescribeLoadBalancerListByCertId(DescribeLoadBalancerListByCertIdRequest req) This API is used to query the list of CLB instances associated with a certificate in a region by certificate ID.
DescribeLoadBalancersResponse	DescribeLoadBalancers(DescribeLoadBalancersRequest req) This API is used to query the list of CLB instances in a region.
DescribeLoadBalancersDetailResponse	DescribeLoadBalancersDetail(DescribeLoadBalancersDetailRequest req) This API is used to query CLB instance details, including listener, rules, and target real servers.
DescribeLoadBalancerTrafficResponse	DescribeLoadBalancerTraffic(DescribeLoadBalancerTrafficRequest req) This API is used to query CLB instances with high traffic under the current account, and return the top 10 results.
DescribeQuotaResponse	DescribeQuota(DescribeQuotaRequest req) This API is used to query various quotas in the current region.
DescribeRewriteResponse	DescribeRewrite(DescribeRewriteRequest req) This API (DescribeRewrite) is used to query the redirection relationship between the forwarding rules of a CLB instance by instance ID.
DescribeTargetGroupInstancesResponse	DescribeTargetGroupInstances(DescribeTargetGroupInstancesRequest req) This API is used to get the information of servers bound to a target group.
DescribeTargetGroupListResponse	DescribeTargetGroupList(DescribeTargetGroupListRequest req) This API is used to get the target group list.
DescribeTargetGroupsResponse	DescribeTargetGroups(DescribeTargetGroupsRequest req) This API is used to query the target group information.
DescribeTargetHealthResponse	DescribeTargetHealth(DescribeTargetHealthRequest req) This API (DescribeTargetHealth) is used to query the health check result of a real server of a CLB instance.
DescribeTargetsResponse	DescribeTargets(DescribeTargetsRequest req) This API (DescribeTargets) is used to query the list of real servers bound to some listeners of a CLB instance.
DescribeTaskStatusResponse	DescribeTaskStatus(DescribeTaskStatusRequest req) This API is used to query the execution status of an async task.
DisassociateTargetGroupsResponse	DisassociateTargetGroups(DisassociateTargetGroupsRequest req) This API is used to unbind target groups from a rule.
ManualRewriteResponse	ManualRewrite(ManualRewriteRequest req) After the original access address and the address to be redirected are configured manually, the system will automatically redirect requests made to the original access address to the target address of the corresponding path.
ModifyBlockIPListResponse	ModifyBlockIPList(ModifyBlockIPListRequest req) This API is used to modify the client IP blocklist of a CLB instance.
ModifyDomainResponse	ModifyDomain(ModifyDomainRequest req) This API (ModifyDomain) is used to modify a domain name under a layer-7 CLB listener.
ModifyDomainAttributesResponse	ModifyDomainAttributes(ModifyDomainAttributesRequest req) This API is used to modify the domain name-level attributes of a layer-7 listener's forwarding rule, such as modifying the domain name, changing the DefaultServer, enabling/disabling HTTP/2, and modifying certificates.
ModifyListenerResponse	ModifyListener(ModifyListenerRequest req) This API (ModifyListener) is used to modify the attributes of a CLB listener, such as listener name, health check parameter, certificate information, and forwarding policy.
ModifyLoadBalancerAttributesResponse	ModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest req) This API is used to modify the attributes of a CLB instance such as name and cross-region attributes.
ModifyRuleResponse	ModifyRule(ModifyRuleRequest req) This API (ModifyRule) is used to modify the attributes of a forwarding rule under a layer-7 CLB listener, such as forwarding path, health check attribute, and forwarding policy.
ModifyTargetGroupAttributeResponse	ModifyTargetGroupAttribute(ModifyTargetGroupAttributeRequest req) This API is used to rename a target group or modify its default port attribute.
ModifyTargetGroupInstancesPortResponse	ModifyTargetGroupInstancesPort(ModifyTargetGroupInstancesPortRequest req) This API is used to modify server ports of a target group in batches.
ModifyTargetGroupInstancesWeightResponse	ModifyTargetGroupInstancesWeight(ModifyTargetGroupInstancesWeightRequest req) This API is used to modify server weights of a target group in batches.
ModifyTargetPortResponse	ModifyTargetPort(ModifyTargetPortRequest req) This API (ModifyTargetPort) is used to modify the port of a real server bound to a listener.
ModifyTargetWeightResponse	ModifyTargetWeight(ModifyTargetWeightRequest req) This API (ModifyTargetWeight) is used to modify the forwarding weight of a real server bound to a CLB instance.
RegisterTargetGroupInstancesResponse	RegisterTargetGroupInstances(RegisterTargetGroupInstancesRequest req) This API is used to register servers to a target group.
RegisterTargetsResponse	RegisterTargets(RegisterTargetsRequest req) This API (RegisterTargets) is used to bind one or more real servers to a CLB listener or layer-7 forwarding rule.
RegisterTargetsWithClassicalLBResponse	RegisterTargetsWithClassicalLB(RegisterTargetsWithClassicalLBRequest req) This API (RegisterTargetsWithClassicalLB) is used to bind real servers to a classic CLB.
ReplaceCertForLoadBalancersResponse	ReplaceCertForLoadBalancers(ReplaceCertForLoadBalancersRequest req) This API (ReplaceCertForLoadBalancers) is used to replace the certificate associated with a CLB instance.
SetLoadBalancerClsLogResponse	SetLoadBalancerClsLog(SetLoadBalancerClsLogRequest req) This API is used to add, delete, and update the CLS topic of a CLB instance.
SetLoadBalancerSecurityGroupsResponse	SetLoadBalancerSecurityGroups(SetLoadBalancerSecurityGroupsRequest req) This API (SetLoadBalancerSecurityGroups) is used to bind/unbind security groups for a public network CLB instance.
SetSecurityGroupForLoadbalancersResponse	SetSecurityGroupForLoadbalancers(SetSecurityGroupForLoadbalancersRequest req) This API is used to bind or unbind a security group for multiple public network CLB instances.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, 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)

ClbClient

public ClbClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

AssociateTargetGroups

public AssociateTargetGroupsResponse AssociateTargetGroups(AssociateTargetGroupsRequest req)
                                                    throws TencentCloudSDKException

This API is used to bind target groups to CLB listeners (layer-4 protocol) or forwarding rules (layer-7 protocol). This is an async API. After it is returned successfully, you can call the `DescribeTaskStatus` API with the returned `RequestID` as an input parameter to check whether this task is successful.

Parameters:

req - AssociateTargetGroupsRequest

Returns:

AssociateTargetGroupsResponse

Throws:

TencentCloudSDKException

AutoRewrite

public AutoRewriteResponse AutoRewrite(AutoRewriteRequest req)
                                throws TencentCloudSDKException

An HTTPS:443 listener needs to be created first, along with a forwarding rule. When this API is called, an HTTP:80 listener will be created automatically if it did not exist and a forwarding rule corresponding to `Domains` (specified in the input parameter) under the HTTPS:443 listener will also be created. After successful creation, access requests to an HTTP:80 address will be redirected to an HTTPS:443 address automatically.

Parameters:

req - AutoRewriteRequest

Returns:

AutoRewriteResponse

Throws:

TencentCloudSDKException

BatchDeregisterTargets

public BatchDeregisterTargetsResponse BatchDeregisterTargets(BatchDeregisterTargetsRequest req)
                                                      throws TencentCloudSDKException

This API is used to unbind layer-4/layer-7 real servers in batches.

Parameters:

req - BatchDeregisterTargetsRequest

Returns:

BatchDeregisterTargetsResponse

Throws:

TencentCloudSDKException

BatchModifyTargetWeight

public BatchModifyTargetWeightResponse BatchModifyTargetWeight(BatchModifyTargetWeightRequest req)
                                                        throws TencentCloudSDKException

This API is used to modify the forwarding weights of real servers bound to a CLB listener in batches. It supports layer-4 and layer-7 CLB listeners but not Classic CLB. This is an async API. After it is returned successfully, you can call the `DescribeTaskStatus` API with the returned `RequestID` as an input parameter to check whether this task is successful.

Parameters:

req - BatchModifyTargetWeightRequest

Returns:

BatchModifyTargetWeightResponse

Throws:

TencentCloudSDKException

BatchRegisterTargets

public BatchRegisterTargetsResponse BatchRegisterTargets(BatchRegisterTargetsRequest req)
                                                  throws TencentCloudSDKException

This API is used to bind CVM instances or ENIs in batches. It supports cross-region binding and layer-4 and layer-7 (TCP, UDP, HTTP, HTTPS) protocols.

Parameters:

req - BatchRegisterTargetsRequest

Returns:

BatchRegisterTargetsResponse

Throws:

TencentCloudSDKException

CreateClsLogSet

public CreateClsLogSetResponse CreateClsLogSet(CreateClsLogSetRequest req)
                                        throws TencentCloudSDKException

This API is used to create a CLB exclusive logset for storing CLB logs.

Parameters:

req - CreateClsLogSetRequest

Returns:

CreateClsLogSetResponse

Throws:

TencentCloudSDKException

CreateListener

public CreateListenerResponse CreateListener(CreateListenerRequest req)
                                      throws TencentCloudSDKException

This API is used to create a listener for a CLB instance. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestId as an input parameter to check whether this task is successful.

Parameters:

req - CreateListenerRequest

Returns:

CreateListenerResponse

Throws:

TencentCloudSDKException

CreateLoadBalancer

public CreateLoadBalancerResponse CreateLoadBalancer(CreateLoadBalancerRequest req)
                                              throws TencentCloudSDKException

This API (CreateLoadBalancer) is used to create a CLB instance. To use the CLB service, you first need to purchase one or more instances. After this API is called successfully, a unique instance ID will be returned. There are two types of instances: public network and private network. For more information, see the product types in the product documentation. Note: (1) To apply for a CLB instance in the specified AZ and cross-AZ disaster recovery, please [submit a ticket](https://console.cloud.tencent.com/workorder/category); (2) Currently, IPv6 is supported only in Beijing, Shanghai, and Guangzhou regions. This is an async API. After it is returned successfully, you can call the DescribeLoadBalancers API to query the status of the instance (such as creating and normal) to check whether it is successfully created.

Parameters:

req - CreateLoadBalancerRequest

Returns:

CreateLoadBalancerResponse

Throws:

TencentCloudSDKException

CreateLoadBalancerSnatIps

public CreateLoadBalancerSnatIpsResponse CreateLoadBalancerSnatIps(CreateLoadBalancerSnatIpsRequest req)
                                                            throws TencentCloudSDKException

This API is used to add a SNAT IP for a SnatPro CLB instance. If SnatPro is not enabled for CLB, it will be automatically enabled after the SNAT IP is added.

Parameters:

req - CreateLoadBalancerSnatIpsRequest

Returns:

CreateLoadBalancerSnatIpsResponse

Throws:

TencentCloudSDKException

CreateRule

public CreateRuleResponse CreateRule(CreateRuleRequest req)
                              throws TencentCloudSDKException

This API (CreateRule) is used to create a forwarding rule under an existing layer-7 CLB listener, where real servers must be bound to the rule instead of the listener. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - CreateRuleRequest

Returns:

CreateRuleResponse

Throws:

TencentCloudSDKException

CreateTargetGroup

public CreateTargetGroupResponse CreateTargetGroup(CreateTargetGroupRequest req)
                                            throws TencentCloudSDKException

This API is used to create a target group. This feature is in beta test, if you want to try it out, please [submit a ticket](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

This API is used to create a topic with the full-text index and key-value index enabled by default. The creation will fail if there is no CLB exclusive logset.

Parameters:

req - CreateTopicRequest

Returns:

CreateTopicResponse

Throws:

TencentCloudSDKException

DeleteListener

public DeleteListenerResponse DeleteListener(DeleteListenerRequest req)
                                      throws TencentCloudSDKException

This API is used to delete a listener from a CLB instance (layer-4 or layer-7). This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - DeleteListenerRequest

Returns:

DeleteListenerResponse

Throws:

TencentCloudSDKException

DeleteLoadBalancer

public DeleteLoadBalancerResponse DeleteLoadBalancer(DeleteLoadBalancerRequest req)
                                              throws TencentCloudSDKException

This API (DeleteLoadBalancer) is used to delete one or more specified CLB instances. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestId as an input parameter to check whether this task is successful.

Parameters:

req - DeleteLoadBalancerRequest

Returns:

DeleteLoadBalancerResponse

Throws:

TencentCloudSDKException

DeleteLoadBalancerListeners

public DeleteLoadBalancerListenersResponse DeleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest req)
                                                                throws TencentCloudSDKException

This API is used to delete multiple listeners of a CLB instance. This is an async API. After it is returned successfully, you can call the `DescribeTaskStatus` API with the returned `RequestID` as an input parameter to check whether this task is successful.

Parameters:

req - DeleteLoadBalancerListenersRequest

Returns:

DeleteLoadBalancerListenersResponse

Throws:

TencentCloudSDKException

DeleteLoadBalancerSnatIps

public DeleteLoadBalancerSnatIpsResponse DeleteLoadBalancerSnatIps(DeleteLoadBalancerSnatIpsRequest req)
                                                            throws TencentCloudSDKException

This API is used to delete a SNAT IP for a SnatPro CLB instance.

Parameters:

req - DeleteLoadBalancerSnatIpsRequest

Returns:

DeleteLoadBalancerSnatIpsResponse

Throws:

TencentCloudSDKException

DeleteRewrite

public DeleteRewriteResponse DeleteRewrite(DeleteRewriteRequest req)
                                    throws TencentCloudSDKException

This API (DeleteRewrite) is used to delete the redirection relationship between the specified forwarding rules.

Parameters:

req - DeleteRewriteRequest

Returns:

DeleteRewriteResponse

Throws:

TencentCloudSDKException

DeleteRule

public DeleteRuleResponse DeleteRule(DeleteRuleRequest req)
                              throws TencentCloudSDKException

This API (DeleteRule) is used to delete a forwarding rule under a layer-7 CLB instance listener This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - DeleteRuleRequest

Returns:

DeleteRuleResponse

Throws:

TencentCloudSDKException

DeleteTargetGroups

public DeleteTargetGroupsResponse DeleteTargetGroups(DeleteTargetGroupsRequest req)
                                              throws TencentCloudSDKException

This API is used to delete a target group.

Parameters:

req - DeleteTargetGroupsRequest

Returns:

DeleteTargetGroupsResponse

Throws:

TencentCloudSDKException

DeregisterTargetGroupInstances

public DeregisterTargetGroupInstancesResponse DeregisterTargetGroupInstances(DeregisterTargetGroupInstancesRequest req)
                                                                      throws TencentCloudSDKException

This API is used to unbind a server from a target group. This is an async API. After it is returned successfully, you can call the `DescribeTaskStatus` API with the returned `RequestID` as an input parameter to check whether this task is successful.

Parameters:

req - DeregisterTargetGroupInstancesRequest

Returns:

DeregisterTargetGroupInstancesResponse

Throws:

TencentCloudSDKException

DeregisterTargets

public DeregisterTargetsResponse DeregisterTargets(DeregisterTargetsRequest req)
                                            throws TencentCloudSDKException

This API (DeregisterTargets) is used to unbind one or more real servers from a CLB listener or forwarding rule. For layer-4 listeners, only the listener ID needs to be specified. For layer-7 listeners, the forwarding rule also needs to be specified through LocationId or Domain+Url. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - DeregisterTargetsRequest

Returns:

DeregisterTargetsResponse

Throws:

TencentCloudSDKException

DeregisterTargetsFromClassicalLB

public DeregisterTargetsFromClassicalLBResponse DeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req)
                                                                          throws TencentCloudSDKException

This API (DeregisterTargetsFromClassicalLB) is used to unbind real servers from a classic load balancer. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestId as an input parameter to check whether this task is successful.

Parameters:

req - DeregisterTargetsFromClassicalLBRequest

Returns:

DeregisterTargetsFromClassicalLBResponse

Throws:

TencentCloudSDKException

DescribeBlockIPList

public DescribeBlockIPListResponse DescribeBlockIPList(DescribeBlockIPListRequest req)
                                                throws TencentCloudSDKException

This API is used to query the list of blocked IPs (blocklist) of a CLB instance. (This API is in beta test. To use it, please submit a ticket.)

Parameters:

req - DescribeBlockIPListRequest

Returns:

DescribeBlockIPListResponse

Throws:

TencentCloudSDKException

DescribeBlockIPTask

public DescribeBlockIPTaskResponse DescribeBlockIPTask(DescribeBlockIPTaskRequest req)
                                                throws TencentCloudSDKException

This API is used to query the execution status of an async IP blocking (blocklisting) task by the async task ID returned by the `ModifyBlockIPList` API. (This API is in beta test. To use it, please submit a ticket.)

Parameters:

req - DescribeBlockIPTaskRequest

Returns:

DescribeBlockIPTaskResponse

Throws:

TencentCloudSDKException

DescribeClassicalLBByInstanceId

public DescribeClassicalLBByInstanceIdResponse DescribeClassicalLBByInstanceId(DescribeClassicalLBByInstanceIdRequest req)
                                                                        throws TencentCloudSDKException

This API (DescribeClassicalLBByInstanceId) is used to get the list of classic CLB IDs through the real server instance ID.

Parameters:

req - DescribeClassicalLBByInstanceIdRequest

Returns:

DescribeClassicalLBByInstanceIdResponse

Throws:

TencentCloudSDKException

DescribeClassicalLBHealthStatus

public DescribeClassicalLBHealthStatusResponse DescribeClassicalLBHealthStatus(DescribeClassicalLBHealthStatusRequest req)
                                                                        throws TencentCloudSDKException

This API (DescribeClassicalLBHealthStatus) is used to get the real server health status of a classic CLB

Parameters:

req - DescribeClassicalLBHealthStatusRequest

Returns:

DescribeClassicalLBHealthStatusResponse

Throws:

TencentCloudSDKException

DescribeClassicalLBListeners

public DescribeClassicalLBListenersResponse DescribeClassicalLBListeners(DescribeClassicalLBListenersRequest req)
                                                                  throws TencentCloudSDKException

This API (DescribeClassicalLBListeners) is used to get the listener information of a classic CLB.

Parameters:

req - DescribeClassicalLBListenersRequest

Returns:

DescribeClassicalLBListenersResponse

Throws:

TencentCloudSDKException

DescribeClassicalLBTargets

public DescribeClassicalLBTargetsResponse DescribeClassicalLBTargets(DescribeClassicalLBTargetsRequest req)
                                                              throws TencentCloudSDKException

This API (DescribeClassicalLBTargets) is used to get the real servers bound to a classic CLB.

Parameters:

req - DescribeClassicalLBTargetsRequest

Returns:

DescribeClassicalLBTargetsResponse

Throws:

TencentCloudSDKException

DescribeClsLogSet

public DescribeClsLogSetResponse DescribeClsLogSet(DescribeClsLogSetRequest req)
                                            throws TencentCloudSDKException

This API is used to get the CLB dedicated logset.

Parameters:

req - DescribeClsLogSetRequest

Returns:

DescribeClsLogSetResponse

Throws:

TencentCloudSDKException

DescribeListeners

public DescribeListenersResponse DescribeListeners(DescribeListenersRequest req)
                                            throws TencentCloudSDKException

This API is used to get the list of listeners by CLB instance ID, listener protocol, or port. If no filter is specified, all listeners under the CLB instance will be returned.

Parameters:

req - DescribeListenersRequest

Returns:

DescribeListenersResponse

Throws:

TencentCloudSDKException

DescribeLoadBalancerListByCertId

public DescribeLoadBalancerListByCertIdResponse DescribeLoadBalancerListByCertId(DescribeLoadBalancerListByCertIdRequest req)
                                                                          throws TencentCloudSDKException

This API is used to query the list of CLB instances associated with a certificate in a region by certificate ID.

Parameters:

req - DescribeLoadBalancerListByCertIdRequest

Returns:

DescribeLoadBalancerListByCertIdResponse

Throws:

TencentCloudSDKException

DescribeLoadBalancerTraffic

public DescribeLoadBalancerTrafficResponse DescribeLoadBalancerTraffic(DescribeLoadBalancerTrafficRequest req)
                                                                throws TencentCloudSDKException

This API is used to query CLB instances with high traffic under the current account, and return the top 10 results. For queries using a sub-account, only the CLB instances authorized to the sub-account will be returned.

Parameters:

req - DescribeLoadBalancerTrafficRequest

Returns:

DescribeLoadBalancerTrafficResponse

Throws:

TencentCloudSDKException

DescribeLoadBalancers

public DescribeLoadBalancersResponse DescribeLoadBalancers(DescribeLoadBalancersRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the list of CLB instances in a region.

Parameters:

req - DescribeLoadBalancersRequest

Returns:

DescribeLoadBalancersResponse

Throws:

TencentCloudSDKException

DescribeLoadBalancersDetail

public DescribeLoadBalancersDetailResponse DescribeLoadBalancersDetail(DescribeLoadBalancersDetailRequest req)
                                                                throws TencentCloudSDKException

This API is used to query CLB instance details, including listener, rules, and target real servers.

Parameters:

req - DescribeLoadBalancersDetailRequest

Returns:

DescribeLoadBalancersDetailResponse

Throws:

TencentCloudSDKException

DescribeQuota

public DescribeQuotaResponse DescribeQuota(DescribeQuotaRequest req)
                                    throws TencentCloudSDKException

This API is used to query various quotas in the current region.

Parameters:

req - DescribeQuotaRequest

Returns:

DescribeQuotaResponse

Throws:

TencentCloudSDKException

DescribeRewrite

public DescribeRewriteResponse DescribeRewrite(DescribeRewriteRequest req)
                                        throws TencentCloudSDKException

This API (DescribeRewrite) is used to query the redirection relationship between the forwarding rules of a CLB instance by instance ID. If no listener ID or forwarding rule ID is specified, all redirection relationships in the instance will be returned.

Parameters:

req - DescribeRewriteRequest

Returns:

DescribeRewriteResponse

Throws:

TencentCloudSDKException

DescribeTargetGroupInstances

public DescribeTargetGroupInstancesResponse DescribeTargetGroupInstances(DescribeTargetGroupInstancesRequest req)
                                                                  throws TencentCloudSDKException

This API is used to get the information of servers bound to a target group.

Parameters:

req - DescribeTargetGroupInstancesRequest

Returns:

DescribeTargetGroupInstancesResponse

Throws:

TencentCloudSDKException

DescribeTargetGroupList

public DescribeTargetGroupListResponse DescribeTargetGroupList(DescribeTargetGroupListRequest req)
                                                        throws TencentCloudSDKException

This API is used to get the target group list.

Parameters:

req - DescribeTargetGroupListRequest

Returns:

DescribeTargetGroupListResponse

Throws:

TencentCloudSDKException

DescribeTargetGroups

public DescribeTargetGroupsResponse DescribeTargetGroups(DescribeTargetGroupsRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the target group information.

Parameters:

req - DescribeTargetGroupsRequest

Returns:

DescribeTargetGroupsResponse

Throws:

TencentCloudSDKException

DescribeTargetHealth

public DescribeTargetHealthResponse DescribeTargetHealth(DescribeTargetHealthRequest req)
                                                  throws TencentCloudSDKException

This API (DescribeTargetHealth) is used to query the health check result of a real server of a CLB instance.

Parameters:

req - DescribeTargetHealthRequest

Returns:

DescribeTargetHealthResponse

Throws:

TencentCloudSDKException

DescribeTargets

public DescribeTargetsResponse DescribeTargets(DescribeTargetsRequest req)
                                        throws TencentCloudSDKException

This API (DescribeTargets) is used to query the list of real servers bound to some listeners of a CLB instance.

Parameters:

req - DescribeTargetsRequest

Returns:

DescribeTargetsResponse

Throws:

TencentCloudSDKException

DescribeTaskStatus

public DescribeTaskStatusResponse DescribeTaskStatus(DescribeTaskStatusRequest req)
                                              throws TencentCloudSDKException

This API is used to query the execution status of an async task. After non-query APIs (used to create/delete CLB instances, listeners, or rules or to bind/unbind real servers) are called successfully, this API needs to be used to query whether the task is successful.

Parameters:

req - DescribeTaskStatusRequest

Returns:

DescribeTaskStatusResponse

Throws:

TencentCloudSDKException

DisassociateTargetGroups

public DisassociateTargetGroupsResponse DisassociateTargetGroups(DisassociateTargetGroupsRequest req)
                                                          throws TencentCloudSDKException

This API is used to unbind target groups from a rule. This is an async API. After it is returned successfully, you can call the `DescribeTaskStatus` API with the returned `RequestID` as an input parameter to check whether this task is successful.

Parameters:

req - DisassociateTargetGroupsRequest

Returns:

DisassociateTargetGroupsResponse

Throws:

TencentCloudSDKException

ManualRewrite

public ManualRewriteResponse ManualRewrite(ManualRewriteRequest req)
                                    throws TencentCloudSDKException

After the original access address and the address to be redirected are configured manually, the system will automatically redirect requests made to the original access address to the target address of the corresponding path. Multiple paths can be configured as a redirection policy under one domain name to achieve automatic redirection between HTTP and HTTPS. A redirection policy should meet the following rules: if A has already been redirected to B, then it cannot be redirected to C (unless the original redirection relationship is deleted and a new one is created), and B cannot be redirected to any other addresses.

Parameters:

req - ManualRewriteRequest

Returns:

ManualRewriteResponse

Throws:

TencentCloudSDKException

ModifyBlockIPList

public ModifyBlockIPListResponse ModifyBlockIPList(ModifyBlockIPListRequest req)
                                            throws TencentCloudSDKException

This API is used to modify the client IP blocklist of a CLB instance. One forwarding rule supports blocking up to 2,000,000 IPs. One blocklist can contain up to 2,000,000 entries. (This API is in beta test. To use it, please submit a ticket.)

Parameters:

req - ModifyBlockIPListRequest

Returns:

ModifyBlockIPListResponse

Throws:

TencentCloudSDKException

ModifyDomain

public ModifyDomainResponse ModifyDomain(ModifyDomainRequest req)
                                  throws TencentCloudSDKException

This API (ModifyDomain) is used to modify a domain name under a layer-7 CLB listener. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - ModifyDomainRequest

Returns:

ModifyDomainResponse

Throws:

TencentCloudSDKException

ModifyDomainAttributes

public ModifyDomainAttributesResponse ModifyDomainAttributes(ModifyDomainAttributesRequest req)
                                                      throws TencentCloudSDKException

This API is used to modify the domain name-level attributes of a layer-7 listener's forwarding rule, such as modifying the domain name, changing the DefaultServer, enabling/disabling HTTP/2, and modifying certificates. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestId as an input parameter to check whether this task is successful.

Parameters:

req - ModifyDomainAttributesRequest

Returns:

ModifyDomainAttributesResponse

Throws:

TencentCloudSDKException

ModifyListener

public ModifyListenerResponse ModifyListener(ModifyListenerRequest req)
                                      throws TencentCloudSDKException

This API (ModifyListener) is used to modify the attributes of a CLB listener, such as listener name, health check parameter, certificate information, and forwarding policy. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - ModifyListenerRequest

Returns:

ModifyListenerResponse

Throws:

TencentCloudSDKException

ModifyLoadBalancerAttributes

public ModifyLoadBalancerAttributesResponse ModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest req)
                                                                  throws TencentCloudSDKException

This API is used to modify the attributes of a CLB instance such as name and cross-region attributes.

Parameters:

req - ModifyLoadBalancerAttributesRequest

Returns:

ModifyLoadBalancerAttributesResponse

Throws:

TencentCloudSDKException

ModifyRule

public ModifyRuleResponse ModifyRule(ModifyRuleRequest req)
                              throws TencentCloudSDKException

This API (ModifyRule) is used to modify the attributes of a forwarding rule under a layer-7 CLB listener, such as forwarding path, health check attribute, and forwarding policy. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - ModifyRuleRequest

Returns:

ModifyRuleResponse

Throws:

TencentCloudSDKException

ModifyTargetGroupAttribute

public ModifyTargetGroupAttributeResponse ModifyTargetGroupAttribute(ModifyTargetGroupAttributeRequest req)
                                                              throws TencentCloudSDKException

This API is used to rename a target group or modify its default port attribute.

Parameters:

req - ModifyTargetGroupAttributeRequest

Returns:

ModifyTargetGroupAttributeResponse

Throws:

TencentCloudSDKException

ModifyTargetGroupInstancesPort

public ModifyTargetGroupInstancesPortResponse ModifyTargetGroupInstancesPort(ModifyTargetGroupInstancesPortRequest req)
                                                                      throws TencentCloudSDKException

This API is used to modify server ports of a target group in batches. This is an async API. After it is returned successfully, you can call the `DescribeTaskStatus` API with the returned `RequestID` as an input parameter to check whether this task is successful.

Parameters:

req - ModifyTargetGroupInstancesPortRequest

Returns:

ModifyTargetGroupInstancesPortResponse

Throws:

TencentCloudSDKException

ModifyTargetGroupInstancesWeight

public ModifyTargetGroupInstancesWeightResponse ModifyTargetGroupInstancesWeight(ModifyTargetGroupInstancesWeightRequest req)
                                                                          throws TencentCloudSDKException

This API is used to modify server weights of a target group in batches. This is an async API. After it is returned successfully, you can call the `DescribeTaskStatus` API with the returned `RequestID` as an input parameter to check whether this task is successful.

Parameters:

req - ModifyTargetGroupInstancesWeightRequest

Returns:

ModifyTargetGroupInstancesWeightResponse

Throws:

TencentCloudSDKException

ModifyTargetPort

public ModifyTargetPortResponse ModifyTargetPort(ModifyTargetPortRequest req)
                                          throws TencentCloudSDKException

This API (ModifyTargetPort) is used to modify the port of a real server bound to a listener. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - ModifyTargetPortRequest

Returns:

ModifyTargetPortResponse

Throws:

TencentCloudSDKException

ModifyTargetWeight

public ModifyTargetWeightResponse ModifyTargetWeight(ModifyTargetWeightRequest req)
                                              throws TencentCloudSDKException

This API (ModifyTargetWeight) is used to modify the forwarding weight of a real server bound to a CLB instance. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - ModifyTargetWeightRequest

Returns:

ModifyTargetWeightResponse

Throws:

TencentCloudSDKException

RegisterTargetGroupInstances

public RegisterTargetGroupInstancesResponse RegisterTargetGroupInstances(RegisterTargetGroupInstancesRequest req)
                                                                  throws TencentCloudSDKException

This API is used to register servers to a target group. This is an async API. After it is returned successfully, you can call the `DescribeTaskStatus` API with the returned `RequestID` as an input parameter to check whether this task is successful.

Parameters:

req - RegisterTargetGroupInstancesRequest

Returns:

RegisterTargetGroupInstancesResponse

Throws:

TencentCloudSDKException

RegisterTargets

public RegisterTargetsResponse RegisterTargets(RegisterTargetsRequest req)
                                        throws TencentCloudSDKException

This API (RegisterTargets) is used to bind one or more real servers to a CLB listener or layer-7 forwarding rule. Before using this API, you need to create relevant layer-4 listeners or layer-7 forwarding rules. For the former (TCP/UDP), only the listener ID needs to be specified, while for the latter (HTTP/HTTPS), the forwarding rule also needs to be specified through LocationId or Domain+Url. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

Parameters:

req - RegisterTargetsRequest

Returns:

RegisterTargetsResponse

Throws:

TencentCloudSDKException

RegisterTargetsWithClassicalLB

public RegisterTargetsWithClassicalLBResponse RegisterTargetsWithClassicalLB(RegisterTargetsWithClassicalLBRequest req)
                                                                      throws TencentCloudSDKException

This API (RegisterTargetsWithClassicalLB) is used to bind real servers to a classic CLB. This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestId as an input parameter to check whether this task is successful.

Parameters:

req - RegisterTargetsWithClassicalLBRequest

Returns:

RegisterTargetsWithClassicalLBResponse

Throws:

TencentCloudSDKException

ReplaceCertForLoadBalancers

public ReplaceCertForLoadBalancersResponse ReplaceCertForLoadBalancers(ReplaceCertForLoadBalancersRequest req)
                                                                throws TencentCloudSDKException

This API (ReplaceCertForLoadBalancers) is used to replace the certificate associated with a CLB instance. A new certificates can be associated with a CLB only after the original certificate is disassociated from it. This API supports replacing server certificates and client certificates. The new certificate to be used can be specified by passing in the certificate ID. If no certificate ID is specified, relevant information such as certificate content must be passed in to create a new certificate and bind it to the CLB. Note: This API can only be called in the Guangzhou region; for other regions, an error will occur due to domain name resolution problems.

Parameters:

req - ReplaceCertForLoadBalancersRequest

Returns:

ReplaceCertForLoadBalancersResponse

Throws:

TencentCloudSDKException

SetLoadBalancerClsLog

public SetLoadBalancerClsLogResponse SetLoadBalancerClsLog(SetLoadBalancerClsLogRequest req)
                                                    throws TencentCloudSDKException

This API is used to add, delete, and update the CLS topic of a CLB instance.

Parameters:

req - SetLoadBalancerClsLogRequest

Returns:

SetLoadBalancerClsLogResponse

Throws:

TencentCloudSDKException

SetLoadBalancerSecurityGroups

public SetLoadBalancerSecurityGroupsResponse SetLoadBalancerSecurityGroups(SetLoadBalancerSecurityGroupsRequest req)
                                                                    throws TencentCloudSDKException

This API (SetLoadBalancerSecurityGroups) is used to bind/unbind security groups for a public network CLB instance. You can use the DescribeLoadBalancers API to query the security groups bound to a CLB instance. This API uses `set` semantics. During a binding operation, the input parameters need to be all security groups to be bound to the CLB instance (including those already bound ones and new ones). During an unbinding operation, the input parameters need to be all the security groups still bound to the CLB instance after the unbinding operation. To unbind all security groups, you can leave this parameter empty or pass in an empty array. Note: Private network CLB do not support binding security groups.

Parameters:

req - SetLoadBalancerSecurityGroupsRequest

Returns:

SetLoadBalancerSecurityGroupsResponse

Throws:

TencentCloudSDKException

SetSecurityGroupForLoadbalancers

public SetSecurityGroupForLoadbalancersResponse SetSecurityGroupForLoadbalancers(SetSecurityGroupForLoadbalancersRequest req)
                                                                          throws TencentCloudSDKException

This API is used to bind or unbind a security group for multiple public network CLB instances. Note: Private network CLB do not support binding security groups.

Parameters:

req - SetSecurityGroupForLoadbalancersRequest

Returns:

SetSecurityGroupForLoadbalancersResponse

Throws:

TencentCloudSDKException