ModifyLoadBalancerAttributes

Baixar

Modo Foco

Tamanho da Fonte

Última atualização: 2026-06-17 17:27:05

1. API Description

Domain name for API request: clb.intl.tencentcloudapi.com.

This API is used to modify the attributes of a CLB instance, such as name and cross-region attributes.
Non-bandwidth-upshift users must add their CLB instance to a bandwidth package to configure cross-domain attributes. To modify the network billing mode, go to the console.
This API is used to perform asynchronous operations. After returning a successful result, call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyLoadBalancerAttributes.
Version	Yes	String	Common Params. The value used for this API: 2018-03-17.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
LoadBalancerId	Yes	String	Unique ID of the Cloud Load Balancer (CLB). You can call the DescribeLoadBalancers API to obtain the ID.
LoadBalancerName	No	String	CLB instance name. Rules: 1-80 internationally compatible characters including letters, Chinese characters, digits, "-", "_", and other common characters (Unicode supplementary characters such as emojis and rare Chinese characters are forbidden).
TargetRegionInfo	No	TargetRegionInfo	Set the backend service information for cross-region binding 1.0 of Cloud Load Balancer.
InternetChargeInfo	No	InternetAccessible	Network billing related parameters
LoadBalancerPassToTarget	No	Boolean	Allow CLB traffic to the Target. Enable (true): verify security groups on CLB; deny CLB traffic to the Target (false): verify security groups on both CLB and backend instances. Leave blank for no modification.
SwitchFlag	No	Integer	Switchover between different billing modes: 0 means no switchover, 1 means switch between prepaid and postpaid, 2 means switch between postpaid modes. Default value: 0
SnatPro	No	Boolean	Whether cross-region binding 2.0 is enabled. Leave it blank for no modification.
DeleteProtect	No	Boolean	Whether to enable deletion protection. Leave it empty to skip modification.
ModifyClassicDomain	No	Boolean	Change the second-level domain name of Cloud Load Balancer (CLB) from mycloud.com to tencentclb.com. The subdomain will also be transformed. After modification, the mycloud.com domain name will become invalid. Leave it blank if no modification is needed.
AssociateEndpoint	No	String	Id of the associated endpoint, which can be queried via the DescribeVpcEndPoint api. Input an empty string to unbind.

3. Output Parameters

Parameter Name	Type	Description
DealName	String	When switching the billing mode of Cloud Load Balancer, you can use this parameter to check if the switch task is successful. Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Renaming a CLB instance

Modifies a CLB instance.

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLoadBalancerAttributes
<Common request parameters>

{
    "LoadBalancerName": "newlbname",
    "LoadBalancerId": "lb-6efswuxa"
}

Output Example

{
    "Response": {
        "DealName": null,
        "RequestId": "78a40898-8210-44c7-8bc6-f83e50878d12"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
FailedOperation.ResourceInOperating	The specified resource is currently being operated. Please try again later.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameter.FormatError	Incorrect parameter format.
InvalidParameter.LBIdNotFound	CLB instance ID error.
InvalidParameter.RegionNotFound	Invalid region.
InvalidParameterValue	Parameter value error.
InvalidParameterValue.Duplicate	Duplicate parameter values.
InvalidParameterValue.Length	Invalid parameter length.
LimitExceeded	The quota limit is exceeded.
MissingParameter	Parameters are missing.
ResourceInsufficient	Insufficient resources.
UnauthorizedOperation	Unauthorized operation.

Ajuda e Suporte

Esta página foi útil?

Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.

comentários

tencent cloud

Cloud Load Balancer