com.tencentcloudapi.gwlb.v20240906

Class GwlbClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.gwlb.v20240906.GwlbClient

public class GwlbClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
GwlbClient(Credential credential, String region)
GwlbClient(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 a CLB.This is an async API.
CreateGatewayLoadBalancerResponse	CreateGatewayLoadBalancer(CreateGatewayLoadBalancerRequest req) This API is used to create a GWLB instance.
CreateTargetGroupResponse	CreateTargetGroup(CreateTargetGroupRequest req) This API is used to create a target group.
DeleteGatewayLoadBalancerResponse	DeleteGatewayLoadBalancer(DeleteGatewayLoadBalancerRequest req) This API is used to delete one or more specified GWLB instances.
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.
DescribeGatewayLoadBalancersResponse	DescribeGatewayLoadBalancers(DescribeGatewayLoadBalancersRequest req) This API is used to query the list of GWLB instances in a region.
DescribeTargetGroupInstancesResponse	DescribeTargetGroupInstances(DescribeTargetGroupInstancesRequest req) This API is used to obtain information on servers bound to a target group.
DescribeTargetGroupInstanceStatusResponse	DescribeTargetGroupInstanceStatus(DescribeTargetGroupInstanceStatusRequest req) This API is used to query the backend service status of a target group.
DescribeTargetGroupListResponse	DescribeTargetGroupList(DescribeTargetGroupListRequest req) This API is used to obtain a target group list.
DescribeTargetGroupsResponse	DescribeTargetGroups(DescribeTargetGroupsRequest req) This API is used to query target group information.
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 disassociate a CLB from a target group.This is an async API.
InquirePriceCreateGatewayLoadBalancerResponse	InquirePriceCreateGatewayLoadBalancer(InquirePriceCreateGatewayLoadBalancerRequest req) This API is used to query the price for creating a GWLB.
ModifyGatewayLoadBalancerAttributeResponse	ModifyGatewayLoadBalancerAttribute(ModifyGatewayLoadBalancerAttributeRequest req) This API is used to modify the attributes of a CLB instance.
ModifyTargetGroupAttributeResponse	ModifyTargetGroupAttribute(ModifyTargetGroupAttributeRequest req) This API is used to modify the name, health check, and other attributes of the target group.
ModifyTargetGroupInstancesWeightResponse	ModifyTargetGroupInstancesWeight(ModifyTargetGroupInstancesWeightRequest req) This API is used to modify the server weight of a target group.This is an async API.
RegisterTargetGroupInstancesResponse	RegisterTargetGroupInstances(RegisterTargetGroupInstancesRequest req) This API is used to register servers to a target group.This is an async API.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GwlbClient

public GwlbClient(Credential credential,
                  String region)

GwlbClient

public GwlbClient(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 a CLB.This is an async API. After the API return succeeds, 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

CreateGatewayLoadBalancer

public CreateGatewayLoadBalancerResponse CreateGatewayLoadBalancer(CreateGatewayLoadBalancerRequest req)
                                                            throws TencentCloudSDKException

This API is used to create a GWLB instance. To use the GWLB service, you must purchase one or more GWLB instances. After this API is called successfully, a unique ID for the GWLB instance will be returned.Note: The default purchase quota for each account in each region is 10.This is an async API. After the API is called successfully, you can use the DescribeGatewayLoadBalancers API to query the status of the GWLB instance (such as creating and normal) to determine whether the creation is successful.

Parameters:

req - CreateGatewayLoadBalancerRequest

Returns:

CreateGatewayLoadBalancerResponse

Throws:

TencentCloudSDKException

CreateTargetGroup

public CreateTargetGroupResponse CreateTargetGroup(CreateTargetGroupRequest req)
                                            throws TencentCloudSDKException

This API is used to create a target group. This feature is in beta testing. If you need to use it, 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

DeleteGatewayLoadBalancer

public DeleteGatewayLoadBalancerResponse DeleteGatewayLoadBalancer(DeleteGatewayLoadBalancerRequest req)
                                                            throws TencentCloudSDKException

This API is used to delete one or more specified GWLB instances. After successful deletion, the GWLB instances will be unbound from the backend service.This is an async API. After the API return succeeds, you can call the DescribeTaskStatus API with the returned RequestId as an input parameter to check whether this task is successful.

Parameters:

req - DeleteGatewayLoadBalancerRequest

Returns:

DeleteGatewayLoadBalancerResponse

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 the API return succeeds, 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

DescribeGatewayLoadBalancers

public DescribeGatewayLoadBalancersResponse DescribeGatewayLoadBalancers(DescribeGatewayLoadBalancersRequest req)
                                                                  throws TencentCloudSDKException

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

Parameters:

req - DescribeGatewayLoadBalancersRequest

Returns:

DescribeGatewayLoadBalancersResponse

Throws:

TencentCloudSDKException

DescribeTargetGroupInstanceStatus

public DescribeTargetGroupInstanceStatusResponse DescribeTargetGroupInstanceStatus(DescribeTargetGroupInstanceStatusRequest req)
                                                                            throws TencentCloudSDKException

This API is used to query the backend service status of a target group. Currently, only GWLB type target groups support querying backend service status.

Parameters:

req - DescribeTargetGroupInstanceStatusRequest

Returns:

DescribeTargetGroupInstanceStatusResponse

Throws:

TencentCloudSDKException

DescribeTargetGroupInstances

public DescribeTargetGroupInstancesResponse DescribeTargetGroupInstances(DescribeTargetGroupInstancesRequest req)
                                                                  throws TencentCloudSDKException

This API is used to obtain information on 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 obtain a target group list.

Parameters:

req - DescribeTargetGroupListRequest

Returns:

DescribeTargetGroupListResponse

Throws:

TencentCloudSDKException

DescribeTargetGroups

public DescribeTargetGroupsResponse DescribeTargetGroups(DescribeTargetGroupsRequest req)
                                                  throws TencentCloudSDKException

This API is used to query target group information.

Parameters:

req - DescribeTargetGroupsRequest

Returns:

DescribeTargetGroupsResponse

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 (for example, used to create/delete CLB instances) 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 disassociate a CLB from a target group.This is an async API. After the API return succeeds, 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

InquirePriceCreateGatewayLoadBalancer

public InquirePriceCreateGatewayLoadBalancerResponse InquirePriceCreateGatewayLoadBalancer(InquirePriceCreateGatewayLoadBalancerRequest req)
                                                                                    throws TencentCloudSDKException

This API is used to query the price for creating a GWLB.

Parameters:

req - InquirePriceCreateGatewayLoadBalancerRequest

Returns:

InquirePriceCreateGatewayLoadBalancerResponse

Throws:

TencentCloudSDKException

ModifyGatewayLoadBalancerAttribute

public ModifyGatewayLoadBalancerAttributeResponse ModifyGatewayLoadBalancerAttribute(ModifyGatewayLoadBalancerAttributeRequest req)
                                                                              throws TencentCloudSDKException

This API is used to modify the attributes of a CLB instance. It supports modifying the name and bandwidth cap of the CLB instance.

Parameters:

req - ModifyGatewayLoadBalancerAttributeRequest

Returns:

ModifyGatewayLoadBalancerAttributeResponse

Throws:

TencentCloudSDKException

ModifyTargetGroupAttribute

public ModifyTargetGroupAttributeResponse ModifyTargetGroupAttribute(ModifyTargetGroupAttributeRequest req)
                                                              throws TencentCloudSDKException

This API is used to modify the name, health check, and other attributes of the target group.

Parameters:

req - ModifyTargetGroupAttributeRequest

Returns:

ModifyTargetGroupAttributeResponse

Throws:

TencentCloudSDKException

ModifyTargetGroupInstancesWeight

public ModifyTargetGroupInstancesWeightResponse ModifyTargetGroupInstancesWeight(ModifyTargetGroupInstancesWeightRequest req)
                                                                          throws TencentCloudSDKException

This API is used to modify the server weight of a target group.This is an async API. After the API return succeeds, 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

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 the API return succeeds, 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